GET
/
v1
/
analytics
/
taps

Authorizations

x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

start_date
string
required

The start date for the analytics in ISO 8601 format (e.g., "2024-09-01").

end_date
string
required

The end date for the analytics in ISO 8601 format (e.g., "2024-09-30").

aggregation
enum<string>
required

The aggregation level for the data.

Available options:
daily,
weekly,
monthly,
quarterly,
yearly
team_id
integer

The team ID to filter by.

team_slug
string

The team slug to filter by.

collection_id
string

The collection ID to filter by.

collection_slug
string

The collection slug to filter by.

product_id
string

The product ID to filter by.

short_url_id
string

The short URL ID to filter by.

country
string

The country to filter by.

region
string

The region to filter by.

os
enum<string>

The operating system to filter by.

Available options:
ios,
android,
other,
all
order_by
enum<string>

The field to order by.

Available options:
date,
total_taps,
unique_users,
conversion_rate
order
enum<string>

The sort order (ascending or descending).

Available options:
asc,
desc
limit
integer
default:
50

The number of results per page.

offset
integer
default:
0

The offset for pagination.

Response

200 - application/json
data
object[]
meta
object
pagination
object
summary
object