{ "info": { "_postman_id": "818c1c97-a579-4efe-85a2-090b05b1d4bc", "name": "Dub Analytics Events 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:50.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "lastUpdatedBy": "35240", "uid": "35240-818c1c97-a579-4efe-85a2-090b05b1d4bc" }, "item": [ { "name": "events", "item": [ { "name": "List all events", "id": "6f3fcda0-f63b-4521-9cc3-d4806d02c41b", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] }, "description": "Retrieve a paginated list of events for the authenticated workspace." }, "response": [ { "id": "36f5bf76-8ccb-40f8-bb0d-999333e89c60", "name": "A list of events", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"event\": \"click\",\n \"timestamp\": \"\",\n \"click\": {\n \"id\": \"\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"continent\": \"\",\n \"device\": \"\",\n \"browser\": \"\",\n \"os\": \"\",\n \"referer\": \"\",\n \"refererUrl\": \"\",\n \"qr\": \"\",\n \"ip\": \"\",\n \"trigger\": \"\"\n },\n \"link\": {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"trackConversion\": \"\",\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"archived\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"disabledAt\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"doIndex\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"geo\": {\n \"non_68e\": \"\",\n \"voluptatec\": \"\"\n },\n \"publicStats\": \"\",\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"purple\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"blue\"\n }\n ],\n \"folderId\": \"\",\n \"webhookIds\": [\n \"\",\n \"\"\n ],\n \"comments\": \"\",\n \"shortLink\": \"\",\n \"qrCode\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\",\n \"userId\": \"\",\n \"workspaceId\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0,\n \"lastClicked\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"tagId\": \"\",\n \"projectId\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ]\n },\n \"click_id\": \"\",\n \"link_id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"continent\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"device\": \"\",\n \"browser\": \"\",\n \"os\": \"\",\n \"qr\": \"\",\n \"ip\": \"\"\n },\n {\n \"event\": \"click\",\n \"timestamp\": \"\",\n \"click\": {\n \"id\": \"\",\n \"timestamp\": \"\",\n \"url\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"region\": \"\",\n \"continent\": \"\",\n \"device\": \"\",\n \"browser\": \"\",\n \"os\": \"\",\n \"referer\": \"\",\n \"refererUrl\": \"\",\n \"qr\": \"\",\n \"ip\": \"\",\n \"trigger\": \"\"\n },\n \"link\": {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"trackConversion\": \"\",\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"archived\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"disabledAt\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"doIndex\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"geo\": {\n \"laboris_94\": \"\",\n \"sint_8e3\": \"\"\n },\n \"publicStats\": \"\",\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"pink\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"pink\"\n }\n ],\n \"folderId\": \"\",\n \"webhookIds\": [\n \"\",\n \"\"\n ],\n \"comments\": \"\",\n \"shortLink\": \"\",\n \"qrCode\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\",\n \"userId\": \"\",\n \"workspaceId\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0,\n \"lastClicked\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"tagId\": \"\",\n \"projectId\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ]\n },\n \"click_id\": \"\",\n \"link_id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"continent\": \"\",\n \"country\": \"\",\n \"city\": \"\",\n \"device\": \"\",\n \"browser\": \"\",\n \"os\": \"\",\n \"qr\": \"\",\n \"ip\": \"\"\n }\n]", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-36f5bf76-8ccb-40f8-bb0d-999333e89c60" }, { "id": "48464bcf-ac72-46e4-879e-6a82b19e2eb1", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-48464bcf-ac72-46e4-879e-6a82b19e2eb1" }, { "id": "06ac2bc7-697c-4986-a81b-0ebd7770775c", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-06ac2bc7-697c-4986-a81b-0ebd7770775c" }, { "id": "f4787a98-b145-4aab-9746-662438a9bb38", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f4787a98-b145-4aab-9746-662438a9bb38" }, { "id": "fa7ba549-ff01-4534-9df1-c50bca1a9f65", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-fa7ba549-ff01-4534-9df1-c50bca1a9f65" }, { "id": "0c40bf07-d7e7-4668-adfa-61b78091b1db", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-0c40bf07-d7e7-4668-adfa-61b78091b1db" }, { "id": "c0e405ea-438c-4258-bf06-fe6a1a849f47", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c0e405ea-438c-4258-bf06-fe6a1a849f47" }, { "id": "9a267578-41ea-4eb1-930b-9993d235a6dd", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-9a267578-41ea-4eb1-930b-9993d235a6dd" }, { "id": "847478c5-7a68-4eb4-95ce-92a34138257b", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-847478c5-7a68-4eb4-95ce-92a34138257b" }, { "id": "c47f6d6e-1dda-484c-a12b-bcdbefec2132", "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}}/events?event=clicks&domain=&key=&linkId=&externalId=&tenantId=&tagId=&folderId=&partnerTagId=&groupId=&partnerId=&customerId=&interval=30d&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=new&query=&programId=&tagIds=&qr=&page=1&limit=100&sortOrder=desc&sortBy=timestamp&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "events" ], "query": [ { "description": "The type of event to retrieve analytics for. Defaults to 'clicks'.", "key": "event", "value": "clicks" }, { "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": "30d" }, { "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": "new" }, { "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": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "100" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "The field to sort the events by. The default is `timestamp`.", "key": "sortBy", "value": "timestamp" }, { "description": "DEPRECATED. Use `sortOrder` instead.", "key": "order", "value": "desc" } ] } }, "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:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c47f6d6e-1dda-484c-a12b-bcdbefec2132" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-6f3fcda0-f63b-4521-9cc3-d4806d02c41b" } ], "id": "304b69f8-a003-465d-bb88-73184dbfcbc5", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-304b69f8-a003-465d-bb88-73184dbfcbc5" } ], "variable": [ { "key": "baseUrl", "value": "https://api.dub.co" } ] }