event |
T.nilable(Models::Operations::Event) |
➖ |
The type of event to retrieve analytics for. Defaults to clicks. |
leads |
group_by |
T.nilable(Models::Operations::QueryParamGroupBy) |
➖ |
The parameter to group the analytics data points by. Defaults to count if undefined. |
|
domain |
T.nilable(::String) |
➖ |
The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: dub.co, dub.co,google.com, -spam.com. |
dub.co |
key |
T.nilable(::String) |
➖ |
The slug of the short link to retrieve analytics for. Must be used along with the corresponding domain of the short link to fetch analytics for a specific short link. |
|
link_id |
T.nilable(::String) |
➖ |
The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: link_123, link_123,link_456, -link_789. |
|
external_id |
T.nilable(::String) |
➖ |
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. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: tenant_123, tenant_123,tenant_456, -tenant_789. |
|
tag_id |
T.nilable(::String) |
➖ |
The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: tag_123, tag_123,tag_456, -tag_789. |
|
folder_id |
T.nilable(::String) |
➖ |
The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: folder_123, folder_123,folder_456, -folder_789. If not provided, return analytics for all links. |
|
partner_tag_id |
T.nilable(::String) |
➖ |
The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: ptag_123, ptag_123,ptag_456, -ptag_789. |
|
group_id |
T.nilable(::String) |
➖ |
The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: grp_123, grp_123,grp_456, -grp_789. |
|
partner_id |
T.nilable(::String) |
➖ |
The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: pn_123, pn_123,pn_456, -pn_789. |
|
customer_id |
T.nilable(::String) |
➖ |
The ID of the customer to retrieve analytics for. |
|
interval |
T.nilable(Models::Operations::Interval) |
➖ |
The interval to retrieve analytics for. If undefined, defaults to 24h. |
|
start |
T.nilable(::String) |
➖ |
The start date and time when to retrieve analytics from. If set, 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. If set along with start, 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(::String) |
➖ |
The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: US, US,BR,FR, -US. |
|
city |
T.nilable(::String) |
➖ |
The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: New York, New York,London, -New York. |
|
region |
T.nilable(::String) |
➖ |
The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: NY, NY,CA, -NY. |
|
continent |
T.nilable(::String) |
➖ |
The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: NA, NA,EU, -AS. |
|
device |
T.nilable(::String) |
➖ |
The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: Desktop, Mobile,Tablet, -Mobile. |
|
browser |
T.nilable(::String) |
➖ |
The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: Chrome, Chrome,Firefox,Safari, -IE. |
|
os |
T.nilable(::String) |
➖ |
The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: Windows, Mac,Windows,Linux, -Windows. |
|
trigger |
T.nilable(::String) |
➖ |
The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: qr, qr,link, -qr. If undefined, returns all trigger types. |
|
event_name |
T.nilable(::String) |
➖ |
The conversion event name to retrieve analytics for. Only available for lead and sale events. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: Sign up, Sign up,Purchase, -Sign up. |
|
referer |
T.nilable(::String) |
➖ |
The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: google.com, google.com,twitter.com, -facebook.com. |
|
referer_url |
T.nilable(::String) |
➖ |
The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: https://google.com, https://google.com,https://twitter.com, -https://spam.com. |
|
url |
T.nilable(::String) |
➖ |
The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: https://example.com, https://example.com,https://other.com, -https://spam.com. |
|
utm_source |
T.nilable(::String) |
➖ |
The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: google, google,twitter, -spam. |
|
utm_medium |
T.nilable(::String) |
➖ |
The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: cpc, cpc,social, -email. |
|
utm_campaign |
T.nilable(::String) |
➖ |
The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). Examples: summer_sale, summer_sale,winter_sale, -old_campaign. |
|
utm_term |
T.nilable(::String) |
➖ |
The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). |
|
utm_content |
T.nilable(::String) |
➖ |
The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with -). |
|
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. |
|
sale_type |
T.nilable(Models::Operations::SaleType) |
➖ |
Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both. |
|
query |
T.nilable(::String) |
➖ |
Search the events by a custom metadata value. Only available for lead and sale events. Examples: metadata['key']:'value' |
|
program_id |
T.nilable(::String) |
➖ |
Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for. |
|
tag_ids |
T.nilable(::String) |
➖ |
Deprecated: Use tagId instead. The tag IDs to retrieve analytics for. |
|
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. |
|