MadelineProtoDocs/old_docs/API_docs_v44/methods/stats.getBroadcastStats.md

58 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2020-10-01 18:05:42 +02:00
title: stats.getBroadcastStats
description: Get [channel statistics](https://core.telegram.org/api/stats)
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-10-01 18:05:42 +02:00
redirect_from: /API_docs/methods/stats_getBroadcastStats.html
2018-04-01 13:19:25 +02:00
---
2020-10-01 18:05:42 +02:00
# Method: stats.getBroadcastStats
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-10-01 18:05:42 +02:00
Get [channel statistics](https://core.telegram.org/api/stats)
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-10-01 18:05:42 +02:00
|dark|[Bool](../types/Bool.md) | Whether to enable dark theme for graph colors | Optional|
2018-08-29 11:18:25 +02:00
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
2018-04-01 13:19:25 +02:00
2020-10-01 18:05:42 +02:00
### Return type: [stats.BroadcastStats](../types/stats.BroadcastStats.md)
2018-04-01 13:19:25 +02:00
2020-10-01 18:05:42 +02:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-10-01 18:05:42 +02:00
$stats.BroadcastStats = $MadelineProto->stats->getBroadcastStats(['dark' => Bool, 'channel' => InputChannel, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-10-01 18:05:42 +02:00
stats.BroadcastStats = stats.getBroadcastStats({dark=Bool, channel=InputChannel, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
2020-10-01 18:05:42 +02:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2019-09-02 17:41:28 +02:00
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2020-10-01 18:05:42 +02:00
|-503|Timeout|Timeout while fetching data|
2018-04-01 13:19:25 +02:00