dub-node/docs/models/operations/retrieveanalyticsrequest.md

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.
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. Takes precedence over start and end. If undefined, defaults to 24h.
start	string	➖	The start date and time when to retrieve analytics from.
end	string	➖	The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
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
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
referer	string	➖	The referer to retrieve analytics for.	google.com
url	string	➖	The URL to retrieve analytics for.
tagId	string	➖	The tag ID to retrieve analytics for.
qr	boolean	➖	Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
root	boolean	➖	Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.