{ "info": { "_postman_id": "c3667b6a-d5f9-45e1-98b6-dcdffd1b10ca", "name": "Dub Analytics API", "description": "Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.\n\nContact Support:\n Name: Dub Support\n Email: support@dub.co", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:32:43.000Z", "updatedAt": "2026-07-28T01:32:43.000Z", "lastUpdatedBy": "35240", "uid": "35240-c3667b6a-d5f9-45e1-98b6-dcdffd1b10ca" }, "item": [ { "name": "analytics", "item": [ { "name": "Retrieve analytics for a link, a domain, or the authenticated workspace.", "id": "aaf2064e-9684-4281-900b-a465981860bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] }, "description": "Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters." }, "response": [ { "id": "d7cb993f-f8e6-40af-80fb-6632c6719e25", "name": "Analytics data", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"clicks\": 0,\n \"leads\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-d7cb993f-f8e6-40af-80fb-6632c6719e25" }, { "id": "976d9f65-57f0-4218-985a-2a4a65493a99", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-976d9f65-57f0-4218-985a-2a4a65493a99" }, { "id": "2e5b1420-3c50-4918-a809-4975a93dea42", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-2e5b1420-3c50-4918-a809-4975a93dea42" }, { "id": "9d8e00a8-8695-427a-923c-7a909194f3f2", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-9d8e00a8-8695-427a-923c-7a909194f3f2" }, { "id": "5114744e-8587-4e7e-8811-a8856953c311", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-5114744e-8587-4e7e-8811-a8856953c311" }, { "id": "71e103a6-2fdc-4c49-82ba-5130f26b9fe2", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-71e103a6-2fdc-4c49-82ba-5130f26b9fe2" }, { "id": "0dd725f4-3e8e-4b46-b187-6626e7a81986", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-0dd725f4-3e8e-4b46-b187-6626e7a81986" }, { "id": "def38d92-0b8c-41c3-bb40-82cc115f5feb", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-def38d92-0b8c-41c3-bb40-82cc115f5feb" }, { "id": "e203dffa-431c-49bb-ab72-2401d267db7a", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-e203dffa-431c-49bb-ab72-2401d267db7a" }, { "id": "8fbc8210-313c-4ee9-be53-7775bb686661", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/analytics?event=clicks&groupBy=count&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=ytd&start=&end=&timezone=UTC&country=&city=®ion=&continent=&device=&browser=&os=&trigger=&referer=&refererUrl=&url=&utm_source=&utm_medium=&utm_campaign=&utm_term=&utm_content=&root=&saleType=recurring&query=&programId=&tagIds=&qr=", "host": [ "{{baseUrl}}" ], "path": [ "analytics" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to `clicks`.", "key": "event", "value": "clicks" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" }, { "description": "The domain to filter analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `dub.co`, `dub.co,google.com`, `-spam.com`.", "key": "domain", "value": "" }, { "description": "The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.", "key": "key", "value": "" }, { "description": "The unique ID of the link to retrieve analytics for.Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `link_123`, `link_123,link_456`, `-link_789`.", "key": "linkId", "value": "" }, { "description": "The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.", "key": "externalId", "value": "" }, { "description": "The ID of the tenant that created the link inside your system. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tenant_123`, `tenant_123,tenant_456`, `-tenant_789`.", "key": "tenantId", "value": "" }, { "description": "The tag ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `tag_123`, `tag_123,tag_456`, `-tag_789`.", "key": "tagId", "value": "" }, { "description": "The folder ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `folder_123`, `folder_123,folder_456`, `-folder_789`. If not provided, return analytics for all links.", "key": "folderId", "value": "" }, { "description": "The partner tag ID(s) to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `ptag_123`, `ptag_123,ptag_456`, `-ptag_789`.", "key": "partnerTagId", "value": "" }, { "description": "The group ID to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `grp_123`, `grp_123,grp_456`, `-grp_789`.", "key": "groupId", "value": "" }, { "description": "The ID of the partner to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `pn_123`, `pn_123,pn_456`, `-pn_789`.", "key": "partnerId", "value": "" }, { "description": "The ID of the customer to retrieve analytics for.", "key": "customerId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "ytd" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code (see https://d.to/geo). Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `US`, `US,BR,FR`, `-US`.", "key": "country", "value": "" }, { "description": "The city to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `New York`, `New York,London`, `-New York`.", "key": "city", "value": "" }, { "description": "The ISO 3166-2 region code to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NY`, `NY,CA`, `-NY`.", "key": "region", "value": "" }, { "description": "The continent to retrieve analytics for. Valid values: AF, AN, AS, EU, NA, OC, SA. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `NA`, `NA,EU`, `-AS`.", "key": "continent", "value": "" }, { "description": "The device to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Desktop`, `Mobile,Tablet`, `-Mobile`.", "key": "device", "value": "" }, { "description": "The browser to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Chrome`, `Chrome,Firefox,Safari`, `-IE`.", "key": "browser", "value": "" }, { "description": "The OS to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Windows`, `Mac,Windows,Linux`, `-Windows`.", "key": "os", "value": "" }, { "description": "The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.", "key": "trigger", "value": "" }, { "description": "The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.", "key": "referer", "value": "" }, { "description": "The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.", "key": "refererUrl", "value": "" }, { "description": "The destination URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://example.com`, `https://example.com,https://other.com`, `-https://spam.com`.", "key": "url", "value": "" }, { "description": "The UTM source to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google`, `google,twitter`, `-spam`.", "key": "utm_source", "value": "" }, { "description": "The UTM medium to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `cpc`, `cpc,social`, `-email`.", "key": "utm_medium", "value": "" }, { "description": "The UTM campaign to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `summer_sale`, `summer_sale,winter_sale`, `-old_campaign`.", "key": "utm_campaign", "value": "" }, { "description": "The UTM term to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_term", "value": "" }, { "description": "The UTM content to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).", "key": "utm_content", "value": "" }, { "description": "Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.", "key": "root", "value": "" }, { "description": "Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.", "key": "saleType", "value": "recurring" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "Deprecated: This is automatically inferred from your workspace's defaultProgramId. The ID of the program to retrieve analytics for.", "key": "programId", "value": "" }, { "description": "Deprecated: Use `tagId` instead. The tag IDs to retrieve analytics for.", "key": "tagIds", "value": "" }, { "description": "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.", "key": "qr", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-8fbc8210-313c-4ee9-be53-7775bb686661" } ], "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-aaf2064e-9684-4281-900b-a465981860bc" } ], "id": "f8515d67-6343-49c2-8fd9-50329d6a0484", "createdAt": "2026-07-28T01:32:44.000Z", "updatedAt": "2026-07-28T01:32:44.000Z", "uid": "35240-f8515d67-6343-49c2-8fd9-50329d6a0484" } ], "variable": [ { "key": "baseUrl", "value": "https://api.dub.co" } ] }