v1
latestOpenAPI 3.0.32026-07-265278189.1 KBAdminApi
Get custom tag usage statistics as an admin
Retrieve usage statistics broken down by custom tags within a specified date range. Optionally aggregate results by day or over the entire period. Results are paginated; use the page parameter with the next_page value from a previous response to retrieve subsequent pages.
get/v2/admin/analytics/custom-tags
Query parameters
start_datestring date required
Start date for the usage report (ISO 8601 date format).
end_datestring date required
End date for the usage report (ISO 8601 date format).
aggregate_by'period' | 'day'
Optional parameter to control aggregation of usage statistics. Possible values:
- period - Aggregate usage over the entire date range (default)
- day - Group usage by individual day
pageinteger
Page number for pagination. Use the integer value returned in next_page from a previous response to retrieve the next page of results.
Response
The custom tag usage statistics for the specified date range.
Example response
{
"custom_tag_usage_report": {
"aggregate_by": "period",
"start_date": "2026-05-03T00:00:00",
"end_date": "2026-05-05T00:00:00",
"next_page": 2,
"usage": [
{
"custom_tag": "example-custom-tag",
"usage_date": "2026-05-04T00:00:00Z",
"breakdown": {
"total_characters": 380,
"text_translation_characters": 380
}
}
]
}
}