helix/io.github.captnblubber.twitchkt.helix.resource/AnalyticsResource/getExtensionAnalytics

getExtensionAnalytics

suspend fun getExtensionAnalytics(extensionId: String? = null, type: String? = null, startedAt: String? = null, endedAt: String? = null, first: Int = 20, after: String? = null): List<ExtensionAnalyticsReport>

Twitch API: Get Extension Analytics

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

Return

the list of analytics reports.

Parameters

extensionId

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

the type of analytics report to get. Possible values are: overview_v2.

startedAt

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,

If you specify a start date, you must specify an end date.

endedAt

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.

first

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.

after

the cursor used to get the next page of results. This parameter is ignored if the extensionId parameter is set.