Telethon/methods/stats/get_broadcast_stats.html
2024-11-17 22:32:52 +01:00

26 lines
3.6 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetBroadcastStatsRequest</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
<script>
document.getElementById("style").href = "../../css/docs."
+ (localStorage.getItem("theme") || "light")
+ ".css";
</script>
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
rel="stylesheet">
</head>
<body>
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Stats</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_broadcast_stats.html">GetBroadcastStatsRequest</a></li></ul><h1>GetBroadcastStatsRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
stats.getBroadcastStats#ab42441a flags:# dark:flags.0?<a href="../../index.html#true">true</a> channel:<a href="../../types/input_channel.html">InputChannel</a> = <a href="../../types/stats/broadcast_stats.html">stats.BroadcastStats</a></pre><button onclick="cp('from telethon.tl.functions.stats import GetBroadcastStatsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/stats/broadcast_stats.html">stats.BroadcastStats</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/stats/broadcast_stats.html">BroadcastStats</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>channel</b></td><td style="text-align:center"><a href="../../types/input_channel.html">InputChannel</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.).</td></tr><tr><td><b>dark</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 4 known errors:</p><table><tr><td><code>BroadcastRequiredError</code></td><td>The request can only be used with a broadcast channel.</td></tr><tr><td><code>ChatAdminRequiredError</code></td><td>Chat admin privileges are required to do that in the specified chat (for example, to send a message in a channel which is not yours), or invalid permissions used for the channel or group.</td></tr><tr><td><code>ChpCallFailError</code></td><td>The statistics cannot be retrieved at this time.</td></tr><tr><td><code>StatsMigrateError</code></td><td>The channel statistics must be fetched from DC {dc}.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
<strong>from</strong> telethon <strong>import</strong> functions, types
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
result = client(functions.stats.GetBroadcastStatsRequest(
channel=<em>'username'</em>,
dark=<strong>True</strong>
))
print(result.stringify())</pre><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>