Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 23.8 KB

RetrieveAnalyticsRequest.md

File metadata and controls

31 lines (28 loc) · 23.8 KB
Raw

RetrieveAnalyticsRequest

Fields

Field Type Required Description Example
event ?Operations\Event ➖ The type of event to retrieve analytics for. Defaults to clicks.
groupBy ?Operations\QueryParamGroupBy ➖ The parameter to group the analytics data points by. Defaults to count if undefined. Note that trigger is deprecated (use triggers instead), but kept for backwards compatibility.
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.
interval ?Operations\Interval ➖ The interval to retrieve analytics for. 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
continent ?Components\ContinentCode ➖ The continent to retrieve analytics for.
country ?Components\CountryCode ➖ The country to retrieve analytics for.
city ?string ➖ The city to retrieve analytics for. New York
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\Trigger ➖ 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.