aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 4e79032..2a64a02 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -454,6 +454,21 @@ Instance dicts
454 # stream websocket address. 454 # stream websocket address.
455 } 455 }
456 456
457Activity dicts
458~~~~~~~~~~~~~~
459.. _activity dict:
460
461.. code-block:: python
462
463 mastodon.instance_activity()[0]
464 # Returns the following dictionary
465 {
466 'week': # Date of the first day of the week the stats were collected for
467 'logins': # Number of users that logged in that week
468 'registrations': # Number of new users that week
469 'statuses': # Number of statuses posted that week
470 }
471
457Report dicts 472Report dicts
458~~~~~~~~~~~~ 473~~~~~~~~~~~~
459.. _report dict: 474.. _report dict:
@@ -517,10 +532,12 @@ version or explicitly determine if a specific minimum Version is available.
517 532
518Reading data: Instances 533Reading data: Instances
519----------------------- 534-----------------------
520This function allows you to fetch information associated with the 535These functions allow you to fetch information associated with the
521current instance. 536current instance.
522 537
523.. automethod:: Mastodon.instance 538.. automethod:: Mastodon.instance
539.. automethod:: Mastodon.instance_activity
540.. automethod:: Mastodon.instance_peers
524 541
525Reading data: Timelines 542Reading data: Timelines
526----------------------- 543-----------------------
Powered by cgit v1.2.3 (git 2.41.0)