Files
dub-node/docs/models/operations/getcitiesbyclicksrequest.md

9.2 KiB
Raw Blame History

GetCitiesByClicksRequest

Fields

Field Type Required Description
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.GetCitiesByClicksQueryParamInterval 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.
country operations.GetCitiesByClicksQueryParamCountry The country to retrieve analytics for.
city string The city to retrieve analytics for.
device string The device to retrieve analytics for.
browser string The browser to retrieve analytics for.
os string The OS to retrieve analytics for.
referer string The referer to retrieve analytics for.
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.