TwitchAnalyticsRequests
Inherits: TwitchRequestBase < RefCounted < Object
Twitch Analytics API for extension and game analytics reports.
Description
TwitchAnalyticsRequests provides methods for retrieving analytics reports for extensions and games. Requires analytics:read:extensions or analytics:read:games OAuth scopes. Access through TwitchAPI.get_analytics().
Tutorials
Methods
void |
get_extension_analytics(params: Dictionary = {}) |
void |
get_game_analytics(params: Dictionary = {}) |
Method Descriptions
void get_extension_analytics(params: Dictionary = {}) 🔗
Gets analytics reports for one or more extensions. Optional params can include extension_id, type, started_at, ended_at, and first. Results are returned via the TwitchAPI.request_completed signal with signal_name "extension_analytics_received".
Response includes: Array of objects with extension_id, URL (CSV download link), type, date_range (started_at, ended_at).
var params = {"extension_id": "my_extension_id", "type": "overview_v2"}
TwitchAPI.get_analytics().get_extension_analytics(params)
# Response: {"data": [{"extension_id": "my_extension_id", "URL": "https://twitch.tv/...", "type": "overview_v2", "date_range": {"started_at": "2025-10-01T00:00:00Z", "ended_at": "2025-10-16T00:00:00Z"}}]}
void get_game_analytics(params: Dictionary = {}) 🔗
Gets analytics reports for one or more games. Optional params can include game_id, type, started_at, ended_at, and first. Results are returned via the TwitchAPI.request_completed signal with signal_name "game_analytics_received".
Response includes: Array of objects with game_id, URL (CSV download link), type, date_range (started_at, ended_at).
var params = {"game_id": "509658"}
TwitchAPI.get_analytics().get_game_analytics(params)
# Response: {"data": [{"game_id": "509658", "URL": "https://twitch.tv/...", "type": "overview_v2", "date_range": {"started_at": "2025-10-01T00:00:00Z", "ended_at": "2025-10-16T00:00:00Z"}}]}