zelo72/documentation
1
0
Fork 0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Code Issues 6 Releases Wiki Activity

Improve streaming API page

Browse Source
This commit is contained in:
Eugen Rochko 2018-09-26 00:19:44 +02:00
parent d440f4a54f
commit 08dea33134
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
content/en/api/streaming.md
View File

@ -13,31 +13,31 @@ Alternatively, a WebSocket connection can also be established.
## Server-sent events (HTTP) ## Server-sent events (HTTP)
### Endpoints ### Endpoints
**GET /api/v1/streaming/user** GET /api/v1/streaming/user
Returns events that are relevant to the authorized user, i.e. home timeline and notifications Returns events that are relevant to the authorized user, i.e. home timeline and notifications
**GET /api/v1/streaming/public** GET /api/v1/streaming/public
Returns all public statuses Returns all public statuses
**GET /api/v1/streaming/public/local** GET /api/v1/streaming/public/local
Returns all local statuses Returns all local statuses
**GET /api/v1/streaming/hashtag** GET /api/v1/streaming/hashtag?tag={id}
Returns all public statuses for a particular hashtag (query param `tag`) Returns all public statuses for a particular hashtag
**GET /api/v1/streaming/hashtag/local** GET /api/v1/streaming/hashtag/local?tag={id}
Returns all local statuses for a particular hashtag (query param `tag`) Returns all local statuses for a particular hashtag
**GET /api/v1/streaming/list** GET /api/v1/streaming/list?list={id}
Returns statuses for a list (query param `list`) Returns statuses for a list
**GET /api/v1/streaming/direct** GET /api/v1/streaming/direct
Returns all direct messages Returns all direct messages
@ -68,8 +68,8 @@ Possible `stream` values:
|Event|Description|What's in the payload| |Event|Description|What's in the payload|
|-----|-----------|---------------------| |-----|-----------|---------------------|
|`update`|A new status has appeared!|Status| |`update`|A new status has appeared|[Status]({{< relref "entities.md#status" >}})|
|`notification`|A new notification|Notification| |`notification`|A new notification has appeared|[Notification]({{< relref "entities.md#notification" >}})|
|`delete`|A status has been deleted|ID of the deleted status| |`delete`|A status has been deleted|ID of the deleted status|
|`filters_changed`|Keyword filters have been changed|| |`filters_changed`|Keyword filters have been changed||