These are the functions of this module:

• twitch_analytics_get_extension_analytics
• twitch_analytics_get_game_analytics

---

Back To Top

Twitch Endpoint: Get Extension Analytics

Gets an analytics report for one or more extensions. The response contains the URLs used to download the reports (CSV files). Learn More

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Success Callback, or Failure Callback.

Syntax:

twitch_analytics_get_extension_analytics(optionals)

Argument	Type	Description
optionals	Struct	- extension_id : String : The extension's client ID. If specified, the response contains a report for the specified extension. If not specified, the response includes a report for each extension that the authenticated user owns. - type : String : The type of analytics report to get. Possible values are: * "overview_v2" - started_at : String : The reporting window's start date, in RFC3339 format. Set the time portion to zeroes (for example, "2021-10-22T00:00:00Z"). The start date must be on or after January 31, 2018. If you specify an earlier date, the API ignores it and uses January 31, 2018. If you specify a start date, you must specify an end date. If you don't specify a start and end date, the report includes all available data since January 31, 2018. The report contains one row of data for each day in the reporting window. - ended_at : String : The reporting window's end date, in RFC3339 format. Set the time portion to zeroes (for example, "2021-10-27T00:00:00Z"). The report is inclusive of the end date. Specify an end date only if you provide a start date. Because it can take up to two days for the data to be available, you must specify an end date that's earlier than today minus one to two days. If not, the API ignores your end date and uses an end date that is today minus one to two days. - first : String : The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs per page. The default is 20. NOTE: While you may specify a maximum value of 100, the response will contain at most 20 URLs per page. - after : String : The cursor used to get the next page of results. The Pagination struct in the response contains the cursor's value. Read More This parameter is ignored if the extension_id parameter is set.

Returns:

N/A

Triggers:

Success Callback

These members are returned in the success callback:

Member	Type	Description
data	Array of Struct	A list of reports. The reports are returned in no particular order; however, the data within each report is in ascending order by date (newest first). The report contains one row of data per day of the reporting window; the report contains rows for only those days that the extension was used. The array is empty if there are no reports.
├── extension_id	String	An ID that identifies the extension that the report was generated for.
├── URL	String	The URL that you use to download the report. The URL is valid for 5 minutes.
├── type	String	The type of report.
├── date_range	Struct	The reporting window's start and end dates, in RFC3339 format.
├── started_at	String	The reporting window's start date.
└── ended_at	String	The reporting window's end date.
└── pagination	Struct	Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through. Read More
└── cursor	String	The cursor used to get the next page of results. Use the cursor to set the request's after parameter.

Failure Callback

This method is triggered on failure.

---

Back To Top

Twitch Endpoint: Get Game Analytics

This function gets an analytics report for one or more games. The response contains the URLs used to download the reports (CSV files). Learn more

Syntax:

twitch_analytics_get_game_analytics(optionals)

Argument	Type	Description
optionals	Struct	The optional parameters to be passed into the function: - game_id : String : The game's client ID. If specified, the response contains a report for the specified game. If not specified, the response includes a report for each of the authenticated user's games. - type : String : The type of analytics report to get. Possible values are: * "overview_v2" - started_at : String : The reporting window's start date, in RFC3339 format. Set the time portion to zeroes (for example, "2021-10-22T00:00:00Z"). If you specify a start date, you must specify an end date. The start date must be within one year of today's date. If you specify an earlier date, the API ignores it and uses a date that's one year prior to today's date. If you don't specify a start and end date, the report includes all available data for the last 365 days from today. The report contains one row of data for each day in the reporting window. - ended_at : String : The reporting window's end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The report is inclusive of the end date. Specify an end date only if you provide a start date. Because it can take up to two days for the data to be available, you must specify an end date that's earlier than today minus one to two days. If not, the API ignores your end date and uses an end date that is today minus one to two days. - first : Real : The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs per page. The default is 20. NOTE: While you may specify a maximum value of 100, the response will contain at most 20 URLs per page. - after : String : The cursor used to get the next page of results. The Pagination struct in the response contains the cursor's value. Read more This parameter is ignored if game_id parameter is set.

Returns:

N/A