MadelineProtoDocs/docs/API_docs/methods/stats.getBroadcastStats.md

58 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-03 14:11:09 +02:00
---
title: stats.getBroadcastStats
2020-06-16 17:50:25 +02:00
description: Get [channel statistics](https://core.telegram.org/api/stats)
2020-04-03 14:11:09 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/stats_getBroadcastStats.html
---
2020-06-16 17:50:25 +02:00
# Method: stats.getBroadcastStats
2020-04-03 14:11:09 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Get [channel statistics](https://core.telegram.org/api/stats)
2020-04-03 14:11:09 +02:00
### Parameters:
2020-06-16 17:50:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|dark|[Bool](../types/Bool.md) | Whether to enable dark theme for graph colors | Optional|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
2020-04-03 14:11:09 +02:00
### Return type: [stats.BroadcastStats](../types/stats.BroadcastStats.md)
2020-06-16 17:50:25 +02:00
### Can bots use this method: **NO**
2020-04-03 14:11:09 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
$stats.BroadcastStats = $MadelineProto->stats->getBroadcastStats(['dark' => Bool, 'channel' => InputChannel, ]);
```
Or, if you're into Lua:
```lua
stats.BroadcastStats = stats.getBroadcastStats({dark=Bool, channel=InputChannel, })
```
2020-06-16 17:50:25 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|-503|Timeout|Timeout while fetching data|