Fetch block click analytics
Retrieve analytics for block clicks over a specified date range, with various filters and aggregation levels.
Authorizations
The API key required for accessing protected routes. It should be included in the request headers as x-api-key
.
Query Parameters
The start date for the analytics in ISO 8601 format (e.g., "2024-09-01").
The end date for the analytics in ISO 8601 format (e.g., "2024-09-30").
The aggregation level for the data.
daily
, weekly
, monthly
, quarterly
, yearly
The page path to filter by.
The team ID to filter by.
The team slug to filter by.
The collection ID to filter by.
The collection slug to filter by.
The token ID to filter by.
The block ID to filter by.
The block type to filter by.
external_url
, reward
, dialog
, all
The dialog content type to filter by.
video
, image
, carousel
, post
, iframe
, all
The country to filter by.
The region to filter by.
The device type to filter by.
mobile
, tablet
, desktop
, all
The minimum block index to filter by.
The maximum block index to filter by.
The field to order by.
date
, total_clicks
, unique_users
, avg_dialog_duration
The sort order (ascending or descending).
asc
, desc
The number of results per page.
The offset for pagination.