mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 12:27:48 +00:00
22 lines
8.2 KiB
Markdown
22 lines
8.2 KiB
Markdown
# GetTimeseriesAnalyticsRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
|
| `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.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
|
| `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
|
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
|
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
|
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
|
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
|
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
|
| `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. | |