Skip to content

Latest commit

 

History

History
45 lines (42 loc) · 32.9 KB

listeventsrequest.md

File metadata and controls

45 lines (42 loc) · 32.9 KB

ListEventsRequest

Fields

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