event |
T.nilable(::OpenApiSDK::Operations::QueryParamEvent) |
➖ |
The type of event to retrieve analytics for. Defaults to 'clicks'. |
|
domain |
T.nilable(::String) |
➖ |
The domain to filter analytics for. |
|
key |
T.nilable(::String) |
➖ |
The short link slug. |
|
link_id |
T.nilable(::String) |
➖ |
The unique ID of the short link on Dub. |
|
external_id |
T.nilable(::String) |
➖ |
This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter. |
|
tenant_id |
T.nilable(::String) |
➖ |
The ID of the tenant that created the link inside your system. |
|
program_id |
T.nilable(::String) |
➖ |
The ID of the program to retrieve analytics for. |
|
partner_id |
T.nilable(::String) |
➖ |
The ID of the partner to retrieve analytics for. |
|
interval |
T.nilable(::OpenApiSDK::Operations::QueryParamInterval) |
➖ |
The interval to retrieve events for. Takes precedence over start and end. If undefined, defaults to 24h. |
|
start |
T.nilable(::String) |
➖ |
The start date and time when to retrieve analytics from. Takes precedence over interval. |
|
end_ |
T.nilable(::String) |
➖ |
The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over interval. |
|
timezone |
T.nilable(::String) |
➖ |
The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. |
America/New_York |
country |
T.nilable(::OpenApiSDK::Shared::CountryCode) |
➖ |
The country to retrieve analytics for. |
|
city |
T.nilable(::String) |
➖ |
The city to retrieve analytics for. |
New York |
region |
T.nilable(::String) |
➖ |
The ISO 3166-2 region code to retrieve analytics for. |
|
continent |
T.nilable(::OpenApiSDK::Shared::ContinentCode) |
➖ |
The continent to retrieve analytics for. |
|
device |
T.nilable(::String) |
➖ |
The device to retrieve analytics for. |
Desktop |
browser |
T.nilable(::String) |
➖ |
The browser to retrieve analytics for. |
Chrome |
os |
T.nilable(::String) |
➖ |
The OS to retrieve analytics for. |
Windows |
trigger |
T.nilable(::OpenApiSDK::Operations::QueryParamTrigger) |
➖ |
The trigger to retrieve analytics for. If undefined, return both QR and link clicks. |
|
referer |
T.nilable(::String) |
➖ |
The referer to retrieve analytics for. |
google.com |
referer_url |
T.nilable(::String) |
➖ |
The full referer URL to retrieve analytics for. |
https://dub.co/blog |
url |
T.nilable(::String) |
➖ |
The URL to retrieve analytics for. |
|
tag_id |
T.nilable(::String) |
➖ |
Deprecated. Use tagIds instead. The tag ID to retrieve analytics for. |
|
tag_ids |
T.nilable(::Object) |
➖ |
The tag IDs to retrieve analytics for. |
|
folder_id |
T.nilable(::String) |
➖ |
The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links. |
|
qr |
T.nilable(T::Boolean) |
➖ |
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 |
T.nilable(T::Boolean) |
➖ |
Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
utm_source |
T.nilable(::String) |
➖ |
The UTM source of the short link. |
|
utm_medium |
T.nilable(::String) |
➖ |
The UTM medium of the short link. |
|
utm_campaign |
T.nilable(::String) |
➖ |
The UTM campaign of the short link. |
|
utm_term |
T.nilable(::String) |
➖ |
The UTM term of the short link. |
|
utm_content |
T.nilable(::String) |
➖ |
The UTM content of the short link. |
|
page |
T.nilable(::Float) |
➖ |
N/A |
|
limit |
T.nilable(::Float) |
➖ |
N/A |
|
sort_order |
T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder) |
➖ |
The sort order. The default is desc. |
|
sort_by |
T.nilable(::OpenApiSDK::Operations::QueryParamSortBy) |
➖ |
The field to sort the events by. The default is timestamp. |
|
order |
T.nilable(::OpenApiSDK::Operations::Order) |
➖ |
DEPRECATED. Use sortOrder instead. |
|