DecAPI/Docs
1
0
Fork 0
mirror of https://github.com/Decicus/DecAPI-Docs.git synced 2024-11-25 22:02:32 +01:00
Code Issues Releases Wiki Activity

[Twitch] Add notes about newly cached endpoints

Browse Source
This commit is contained in:
Alex Thomassen 2020-11-29 02:32:10 +01:00
parent 476d452074
commit 75b4d85527
Signed by: Alex
GPG Key ID: 10BD786B5F6FF5DE
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
public/static/yaml/endpoints/twitch.yaml
View File

@ -20,6 +20,7 @@ endpoints:
notes: notes:
- 'Retrieves the URL of the avatar for the specified user' - 'Retrieves the URL of the avatar for the specified user'
- 'Will fallback to the default Twitch avatar if the user does not have an avatar.' - 'Will fallback to the default Twitch avatar if the user does not have an avatar.'
- 'Avatar URLs are cached by DecAPI for up to 300 seconds (5 minutes) per user.'
- route: "chat_rules/:channel" - route: "chat_rules/:channel"
parameters: parameters:
- name: ":channel" - name: ":channel"
@ -142,6 +143,7 @@ endpoints:
description: "The channel name." description: "The channel name."
notes: notes:
- 'Retrieves the current game the channel has been set to.' - 'Retrieves the current game the channel has been set to.'
- 'The currently set game is cached by DecAPI for up to 60 seconds (1 minute) per channel.'
- route: "help/:search" - route: "help/:search"
parameters: parameters:
- name: ":search" - name: ":search"
@ -284,6 +286,7 @@ endpoints:
- '<strong>This only works for channels that have <a href="{{baseUrl}}/auth/twitch?scopes=user_read+channel_subscriptions&redirect=subpoints" target="_blank" rel="noopener noreferrer">authenticated and authorized</a> this app</strong> (if the channel already uses subcount, this works already).' - '<strong>This only works for channels that have <a href="{{baseUrl}}/auth/twitch?scopes=user_read+channel_subscriptions&redirect=subpoints" target="_blank" rel="noopener noreferrer">authenticated and authorized</a> this app</strong> (if the channel already uses subcount, this works already).'
- 'As of November 12th, 2019 the API has changed and might have some minor inaccuracies. I recommend specifying the "subtract" parameter, while comparing with your <a href="https://www.twitch.tv/dashboard/channel-analytics" target="_blank" rel="noopener noreferrer">dashboard stats</a>.' - 'As of November 12th, 2019 the API has changed and might have some minor inaccuracies. I recommend specifying the "subtract" parameter, while comparing with your <a href="https://www.twitch.tv/dashboard/channel-analytics" target="_blank" rel="noopener noreferrer">dashboard stats</a>.'
- 'Example with subtract: <code>https://decapi.me/twitch/subpoints/decicus?subtract=2</code> will remove 2 subscriber points from the returned value.' - 'Example with subtract: <code>https://decapi.me/twitch/subpoints/decicus?subtract=2</code> will remove 2 subscriber points from the returned value.'
- 'The subscriber point value is cached by DecAPI for up to 120 seconds (2 minutes) per channel.'
- route: "subscriber_emotes/:channel" - route: "subscriber_emotes/:channel"
parameters: parameters:
- name: ":channel" - name: ":channel"
@ -300,6 +303,7 @@ endpoints:
description: 'The channel name.' description: 'The channel name.'
notes: notes:
- 'Retrieves the current title set on the channel.' - 'Retrieves the current title set on the channel.'
- 'The currently set stream title is cached by DecAPI for up to 60 seconds (1 minute) per channel.'
- route: "team_members/:team_id" - route: "team_members/:team_id"
parameters: parameters:
- name: ":team_id" - name: ":team_id"
@ -323,6 +327,7 @@ endpoints:
description: "The channel name." description: "The channel name."
notes: notes:
- 'Works identical to <code>status</code> - Retrieves the current title set on the channel.' - 'Works identical to <code>status</code> - Retrieves the current title set on the channel.'
- 'The currently set stream title is cached by DecAPI for up to 60 seconds (1 minute) per channel.'
- route: "total_views/:channel" - route: "total_views/:channel"
parameters: parameters:
- name: ":channel" - name: ":channel"
@ -353,6 +358,7 @@ endpoints:
notes: notes:
- 'Returns how many viewers the channel has, if they are currently streaming.' - 'Returns how many viewers the channel has, if they are currently streaming.'
- 'Keep in mind this might be slightly inaccurate, due to caching on the Twitch API side.' - 'Keep in mind this might be slightly inaccurate, due to caching on the Twitch API side.'
- 'Viewer count is cached by DecAPI for up to 60 seconds (1 minute) per channel.'
- route: "videos/:channel" - route: "videos/:channel"
parameters: parameters:
- name: ":channel" - name: ":channel"