aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorhalcy <halcy@ARARAGI-KUN>2022-11-27 02:43:22 +0200
committerhalcy <halcy@ARARAGI-KUN>2022-11-27 02:43:22 +0200
commit5cf0fa27a95f8c56280ea429dd1d57529fc490ee (patch)
tree26e4485d4e69052bc53c151ba807b8260185a419 /docs
parent7331f7774ae10d927e086318338989de6bc37cad (diff)
downloadmastodon.py-5cf0fa27a95f8c56280ea429dd1d57529fc490ee.tar.gz
add admin stats APIs
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst49
1 files changed, 45 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 95ae0aa..e7d52dc 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -345,6 +345,18 @@ Toot dicts
345 'poll': # A poll dict if a poll is attached to this status. 345 'poll': # A poll dict if a poll is attached to this status.
346 } 346 }
347 347
348Status edit dicts
349~~~~~~~~~~~~~~~~~
350.. _status edit dict:
351
352.. code-block:: python
353
354 mastodonstatus_history(id)[0]
355 # Returns the following dictionary
356 {
357 TODO
358 }
359
348Mention dicts 360Mention dicts
349~~~~~~~~~~~~~ 361~~~~~~~~~~~~~
350.. _mention dict: 362.. _mention dict:
@@ -902,13 +914,37 @@ Admin domain block dicts
902 'obfuscate': #Boolean. True if domain name is obfuscated when listing. 914 'obfuscate': #Boolean. True if domain name is obfuscated when listing.
903 } 915 }
904 916
905Status edit dicts 917Admin measure dicts
906~~~~~~~~~~~~~~~~~ 918~~~~~~~~~~~~~~~~~~~
907.. _status edit dict: 919.. _admin measure dict:
908 920
909.. code-block:: python 921.. code-block:: python
910 922
911 mastodonstatus_history(id)[0] 923 api.admin_measures(datetime.now() - timedelta(hours=24*5), datetime.now(), active_users=True)
924 # Returns the following dictionary
925 {
926 TODO
927 }
928
929Admin dimension dicts
930~~~~~~~~~~~~~~~~~~~~~
931.. _admin dimension dict:
932
933.. code-block:: python
934
935 api.admin_dimensions(datetime.now() - timedelta(hours=24*5), datetime.now(), languages=True)
936 # Returns the following dictionary
937 {
938 TODO
939 }
940
941Admin retention dicts
942~~~~~~~~~~~~~~~~~~~~~
943.. _admin retention dict:
944
945.. code-block:: python
946
947 api.admin_retention(datetime.now() - timedelta(hours=24*5), datetime.now())
912 # Returns the following dictionary 948 # Returns the following dictionary
913 { 949 {
914 TODO 950 TODO
@@ -1471,6 +1507,11 @@ have admin: scopes attached with a lot of care, but be extra careful with those
1471.. automethod:: Mastodon.admin_update_domain_block 1507.. automethod:: Mastodon.admin_update_domain_block
1472.. automethod:: Mastodon.admin_delete_domain_block 1508.. automethod:: Mastodon.admin_delete_domain_block
1473 1509
1510.. automethod:: Mastodon.admin_measures
1511.. automethod:: Mastodon.admin_dimensions
1512.. automethod:: Mastodon.admin_retention
1513
1514
1474Acknowledgements 1515Acknowledgements
1475---------------- 1516----------------
1476Mastodon.py contains work by a large number of contributors, many of which have 1517Mastodon.py contains work by a large number of contributors, many of which have
Powered by cgit v1.2.3 (git 2.41.0)