mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 12:27:48 +00:00
27 lines
13 KiB
Markdown
27 lines
13 KiB
Markdown
# RetrieveAnalyticsRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
| `event` | [operations.Event](../../models/operations/event.md) | :heavy_minus_sign: | The type of event to retrieve analytics for. Defaults to 'clicks'. | |
|
|
| `groupBy` | [operations.QueryParamGroupBy](../../models/operations/queryparamgroupby.md) | :heavy_minus_sign: | The parameter to group the analytics data points by. Defaults to 'count' if undefined. | |
|
|
| `domain` | *string* | :heavy_minus_sign: | The domain to filter analytics for. | |
|
|
| `key` | *string* | :heavy_minus_sign: | The short link slug. | |
|
|
| `linkId` | *string* | :heavy_minus_sign: | The unique ID of the short link on Dub. | |
|
|
| `externalId` | *string* | :heavy_minus_sign: | 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](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h. | |
|
|
| `start` | *string* | :heavy_minus_sign: | The start date and time when to retrieve analytics from. | |
|
|
| `end` | *string* | :heavy_minus_sign: | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. | |
|
|
| `timezone` | *string* | :heavy_minus_sign: | The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. | America/New_York |
|
|
| `country` | [components.CountryCode](../../models/components/countrycode.md) | :heavy_minus_sign: | The country to retrieve analytics for. | |
|
|
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. | New York |
|
|
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. | Desktop |
|
|
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. | Chrome |
|
|
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. | Windows |
|
|
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. | google.com |
|
|
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. | |
|
|
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. | |
|
|
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. | |
|
|
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. | | |