GET
/
v1
/
collections
/
{id}
/
taps

Authorizations

x-api-key
string
headerrequired

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

Path Parameters

id
string
required

The unique identifier of the collection.

Query Parameters

min_date
string

The earliest date for taps to filter.

max_date
string

The latest date for taps to filter.

postal_code
string

The postal code to filter taps by.

city
string

The city to filter taps by.

region_code
string

The region code (two-letter ISO) to filter taps by.

Required string length: 2
country_code
string

The country code (two-letter ISO) to filter taps by.

Required string length: 2
is_eu
boolean

Filter taps by whether the country is in the European Union.

os
string

The operating system to filter taps by.

device_model
string

The device model to filter taps by.

device_vendor
string

The device vendor to filter taps by.

limit
integer

The maximum number of items to return (1-1000).

Required range: 1 < x < 1000
offset
integer

The number of items to skip before starting to collect the result set.

order
enum<string>

The sort order of the results.

Available options:
asc,
desc
order_by
string

The field by which to order the results.

Response

200 - application/json
data
object[]

List of taps (clicks) on short URLs.

pagination
object