event |
?Operations\QueryParamEvent |
➖ |
The type of event to retrieve analytics for. Defaults to 'clicks'. |
|
domain |
?string |
➖ |
The domain to filter analytics for. |
|
key |
?string |
➖ |
The short link slug. |
|
linkId |
?string |
➖ |
The unique ID of the short link on Dub. |
|
externalId |
?string |
➖ |
This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
|
tenantId |
?string |
➖ |
The ID of the tenant that created the link inside your system. |
|
programId |
?string |
➖ |
The ID of the program to retrieve analytics for. |
|
partnerId |
?string |
➖ |
The ID of the partner to retrieve analytics for. |
|
interval |
?Operations\QueryParamInterval |
➖ |
The interval to retrieve events for. Takes precedence over start and end. If undefined, defaults to 24h. |
|
start |
?string |
➖ |
The start date and time when to retrieve analytics from. Takes precedence over interval. |
|
end |
?string |
➖ |
The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over interval. |
|
timezone |
?string |
➖ |
The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. |
America/New_York |
country |
?Components\CountryCode |
➖ |
The country to retrieve analytics for. |
|
city |
?string |
➖ |
The city to retrieve analytics for. |
New York |
region |
?string |
➖ |
The ISO 3166-2 region code to retrieve analytics for. |
|
continent |
?Components\ContinentCode |
➖ |
The continent to retrieve analytics for. |
|
device |
?string |
➖ |
The device to retrieve analytics for. |
Desktop |
browser |
?string |
➖ |
The browser to retrieve analytics for. |
Chrome |
os |
?string |
➖ |
The OS to retrieve analytics for. |
Windows |
trigger |
?Operations\QueryParamTrigger |
➖ |
The trigger to retrieve analytics for. If undefined, return both QR and link clicks. |
|
referer |
?string |
➖ |
The referer to retrieve analytics for. |
google.com |
refererUrl |
?string |
➖ |
The full referer URL to retrieve analytics for. |
https://dub.co/blog |
url |
?string |
➖ |
The URL to retrieve analytics for. |
|
tagId |
?string |
➖ |
Deprecated. Use tagIds instead. The tag ID to retrieve analytics for. |
|
tagIds |
string|array|null |
➖ |
The tag IDs to retrieve analytics for. |
|
qr |
?bool |
➖ |
Deprecated. Use the trigger field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
root |
?bool |
➖ |
Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
page |
?float |
➖ |
N/A |
|
limit |
?float |
➖ |
N/A |
|
sortOrder |
?Operations\QueryParamSortOrder |
➖ |
The sort order. The default is desc. |
|
sortBy |
?Operations\QueryParamSortBy |
➖ |
The field to sort the events by. The default is timestamp. |
|
order |
?Operations\Order |
➖ |
DEPRECATED. Use sortOrder instead. |
|
utmSource |
?string |
➖ |
The UTM source of the short link. |
|
utmMedium |
?string |
➖ |
The UTM medium of the short link. |
|
utmCampaign |
?string |
➖ |
The UTM campaign of the short link. |
|
utmTerm |
?string |
➖ |
The UTM term of the short link. |
|
utmContent |
?string |
➖ |
The UTM content of the short link. |
|