admin/trends API methods

TODO

GET /api/v1/admin/trends/links HTTP/1.1

Links that have been shared more than others, including unapproved and unreviewed links.

Returns: Array of Trends::Link
OAuth: User token + admin:read
Permissions: Manage Taxonomies
Version history:
3.5.0 - added

Request

Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK 
[  {  "url": "https://twitter.com/arufa_faru/status/1594262272007753728",  "title": "ARuFa on Twitter",  "description": "“言葉をマネするぬいぐるみを改造してエレキギターを直接繋いでみました”",  "type": "link",  "author_name": "",  "author_url": "",  "provider_name": "Twitter",  "provider_url": "",  "html": "",  "width": 400,  "height": 225,  "image": "https://media.chitter.xyz/cache/preview_cards/images/002/162/720/original/b5360261e8ce17fc.jpeg",  "embed_url": "",  "blurhash": "UNFiDM~o-oD%x[xtaxM|xaNHRkjsoft7ofWB",  "history": [  {  "day": "1669507200",  "accounts": "9",  "uses": "9"  },  {  "day": "1669420800",  "accounts": "0",  "uses": "0"  },  {  "day": "1669334400",  "accounts": "0",  "uses": "0"  },  {  "day": "1669248000",  "accounts": "0",  "uses": "0"  },  {  "day": "1669161600",  "accounts": "0",  "uses": "0"  },  {  "day": "1669075200",  "accounts": "0",  "uses": "0"  },  {  "day": "1668988800",  "accounts": "0",  "uses": "0"  }  ]  },  // ... ]
403: Forbidden

Authorized user is missing a permission, or invalid or missing Authorization header

{  "error": "This action is not allowed" }

View trending statuses 

GET /api/v1/admin/trends/statuses HTTP/1.1

Statuses that have been interacted with more than others, including unapproved and unreviewed statuses.

Returns: Array of Status
OAuth: User token + admin:read
Permissions: Manage Taxonomies
Version history:
3.5.0 - added

Request

Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK 
[  {  "id": "109415512969053017",  "created_at": "2022-11-27T11:23:52.000Z",  "in_reply_to_id": null,  "in_reply_to_account_id": null,  // ...  "account": {  "id": "109332240210946752",  // ...  },  "media_attachments": [],  "mentions": [],  "tags": [],  "emojis": [],  "card": null,  "poll": null  },  // ... ]
403: Forbidden

Authorized user is missing a permission, or invalid or missing Authorization header

{  "error": "This action is not allowed" }

View trending tags 

GET /api/v1/admin/trends/tags HTTP/1.1

Tags that are being used more frequently within the past week, including unapproved and unreviewed tags.

Returns: Array of Admin::Tag
OAuth: User token + admin:read
Permissions: Manage Taxonomies
Version history:
3.5.0 - added
4.0.0 - Returns an array of Tag due to a bug
4.1.0 - Bug fixed

Request

Headers
Authorization
required Provide this header with Bearer <user_token> to gain authorized access to this API method.

Response

200: OK 
[  {  "id": "802",  "name": "caturday",  "url": "https://mastodon.example/tags/caturday",  "history": [  {  "day": "1669507200",  "accounts": "53",  "uses": "56"  },  {  "day": "1669420800",  "accounts": "142",  "uses": "171"  },  {  "day": "1669334400",  "accounts": "11",  "uses": "11"  },  {  "day": "1669248000",  "accounts": "8",  "uses": "9"  },  {  "day": "1669161600",  "accounts": "8",  "uses": "20"  },  {  "day": "1669075200",  "accounts": "11",  "uses": "11"  },  {  "day": "1668988800",  "accounts": "17",  "uses": "22"  }  ],  "trendable": true,  "usable": true,  "requires_review": false  }, ]
403: Forbidden

Authorized user is missing a permission, or invalid or missing Authorization header

{  "error": "This action is not allowed" }

See also

app/controllers/api/v1/admin/trends/links_controller.rb
app/controllers/api/v1/admin/trends/statuses_controller.rb
app/controllers/api/v1/admin/trends/tags_controller.rb

Last updated