diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 19 |
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 | ||
457 | Activity 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 | |||
457 | Report dicts | 472 | Report 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 | ||
518 | Reading data: Instances | 533 | Reading data: Instances |
519 | ----------------------- | 534 | ----------------------- |
520 | This function allows you to fetch information associated with the | 535 | These functions allow you to fetch information associated with the |
521 | current instance. | 536 | current instance. |
522 | 537 | ||
523 | .. automethod:: Mastodon.instance | 538 | .. automethod:: Mastodon.instance |
539 | .. automethod:: Mastodon.instance_activity | ||
540 | .. automethod:: Mastodon.instance_peers | ||
524 | 541 | ||
525 | Reading data: Timelines | 542 | Reading data: Timelines |
526 | ----------------------- | 543 | ----------------------- |