{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"linkutm","colors":{"primary":"#ff6200","light":"#ff6200","dark":"#ff6200"},"logo":{"light":"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/light.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=1a0ed464d45ea6d3c2e41d0c7e5ffe1f","dark":"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/dark.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=fcfbf4a77cde2510404e49fc3e1dc061"},"favicon":"https://mintcdn.com/utm-e577acb5/QolUdNrEUEGDmCqg/favicon.svg?fit=max\u0026auto=format\u0026n=QolUdNrEUEGDmCqg\u0026q=85\u0026s=523d83fd0143da408255f709dcdc2f46","navbar":{"links":[{"href":"mailto:hello@linkutm.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.linkutm.com"}},"footer":{"socials":{"x":"https://x.com/linkutm_hq","facebook":"https://www.facebook.com/people/Linkutm/61583414725717","linkedin":"https://www.linkedin.com/company/linkutm","discord":"https://go.linkutm.com/discord"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"utm-e577acb5","hasAudioNarration":false,"actualSubdomain":"utm-e577acb5","customDomains":["docs.linkutm.com"],"gitSource":{"type":"github","owner":"bhargav19-root","repo":"docs","deployBranch":"updated_docs","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5fe659abc0e0a9f4784f6","collectionId":"40371c53-9b88-4e8c-b460-92251e799aed","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5fe659abc0e0a9f4784f6"},"entitlements":{},"buildId":"6ad5fe659abc0e0a9f4784f6","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Links","count":36},{"language":"default","tag":"API Reference","count":25},{"language":"default","tag":"Linkutm Links API","count":21},{"language":"default","tag":"Link Management","count":19},{"language":"default","tag":"Domains","count":7},{"language":"default","tag":"Folders","count":5},{"language":"default","tag":"UTM Standards","count":5},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Tags","count":4},{"language":"default","tag":"Workspaces \u0026 Team","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/analytics/workspace","slug":"/api/analytics/workspace","pageMetadata":{"title":"Workspace analytics","openapi":"GET /analytics","description":"Retrieve click analytics for the workspace.","href":"/api/analytics/workspace"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve click analytics for the workspace.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Workspace analytics","openapi":"GET /analytics","description":"Retrieve click analytics for the workspace.","href":"/api/analytics/workspace"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getWorkspaceAnalytics","summary":"Workspace analytics","tags":["Analytics"],"description":"Retrieve click analytics for the workspace.","x-permission":"analytics.view","parameters":["35897a30-2b5a-48cf-9286-9b5782197e5a","488ee0ec-8ae2-4632-aacb-f14020eb9d10","348f69c5-17ec-4811-98d2-e38e4731fe51","96b79a31-a89a-4a0b-a980-affaf2746a8d","c8426e07-74fa-45bb-b9c9-fd1364072225"],"responses":{"200":"15f65fad-6ebc-4163-bb82-a42fa42ee9d5","400":"76fdf6c3-4610-411e-847b-e39b3509eb31","401":"ff35df54-6a21-4449-9618-bc29a86d3bfc","403":"aaeee5d3-10f9-4c3d-b401-3edbc0b2a5b8","500":"901afb3e-a739-409e-b4a4-3680151aff58"},"method":"get","type":"path","servers":["42407d43-bba1-4aa5-8fc3-db9fec6cb642"],"security":["4507dab4-7aee-4d72-b560-04992f6b9435","48d713e5-206e-44b3-902f-aef17052ddd6"],"path":"/analytics","baseUrlOptions":["https://api.linkutm.com/api/v1"],"title":"Workspace analytics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"35897a30-2b5a-48cf-9286-9b5782197e5a":{"name":"kind","in":"query","required":false,"description":"Show analytics for all, short links only (`link`) or QR codes only (`qr`).","schema":{"type":"string","enum":["all","link","qr"],"default":"all","isRequired":false,"description":"Show analytics for all, short links only (`link`) or QR codes only (`qr`).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"488ee0ec-8ae2-4632-aacb-f14020eb9d10":{"name":"interval","in":"query","required":false,"description":"Preset date range: whole days up to the end of today (`24h` is the last 24 hours). Use this instead of `startDate` and `endDate`.","schema":{"type":"string","enum":["24h","7d","30d","90d","1y"],"example":"30d","default":"30d","isRequired":false,"description":"Preset date range: whole days up to the end of today (`24h` is the last 24 hours). Use this instead of `startDate` and `endDate`.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"348f69c5-17ec-4811-98d2-e38e4731fe51":{"name":"timezone","in":"query","required":false,"description":"Time zone used to count `interval` days. Defaults to `Asia/Kolkata`.","schema":{"type":"string","enum":["Asia/Kolkata","UTC","Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Coyhaique","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Nuuk","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kathmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Yangon","Asia/Riyadh","Asia/Ho_Chi_Minh","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kyiv","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Kanton","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Chuuk","Pacific/Wake","Pacific/Wallis"],"example":"Asia/Kolkata","isRequired":false,"description":"Time zone used to count `interval` days. Defaults to `Asia/Kolkata`.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"96b79a31-a89a-4a0b-a980-affaf2746a8d":{"name":"startDate","in":"query","required":false,"description":"Start date in `YYYY-MM-DD` format, e.g. `2026-07-01`. Required when `interval` is not sent.","schema":{"type":"string","format":"date","example":"2026-07-01","isRequired":false,"description":"Start date in `YYYY-MM-DD` format, e.g. `2026-07-01`. Required when `interval` is not sent.","uniqueKey":"","typeLabel":"string\u003cdate>"}},"c8426e07-74fa-45bb-b9c9-fd1364072225":{"name":"endDate","in":"query","required":false,"description":"End date in `YYYY-MM-DD` format, e.g. `2026-07-31`. Required when `interval` is not sent.","schema":{"type":"string","format":"date","example":"2026-07-31","isRequired":false,"description":"End date in `YYYY-MM-DD` format, e.g. `2026-07-31`. Required when `interval` is not sent.","uniqueKey":"","typeLabel":"string\u003cdate>"}}},"responses":{"15f65fad-6ebc-4163-bb82-a42fa42ee9d5":{"description":"Workspace click analytics.","content":{"application/json":{"schema":{"type":"object","properties":{"totalClicks":{"type":"integer","uniqueKey":"totalClicks","typeLabel":"integer"},"uniqueVisitors":{"type":"integer","description":"Distinct client IPs in the range.","uniqueKey":"uniqueVisitors","typeLabel":"integer"},"totalLinks":{"type":"integer","uniqueKey":"totalLinks","typeLabel":"integer"},"uniqueVisitorRate":{"type":"number","uniqueKey":"uniqueVisitorRate","typeLabel":"number"},"referrers":{"type":"integer","description":"Distinct referrers seen.","uniqueKey":"referrers","typeLabel":"integer"},"topLinks":{"type":"array","items":{"type":"object","uniqueKey":"topLinks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topLinks","typeLabel":"object[]"},"clicksOverTime":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2026-08-01","uniqueKey":"clicksOverTime.items.[INDEX].date","typeLabel":"string\u003cdate>"},"clicks":{"type":"integer","uniqueKey":"clicksOverTime.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"clicksOverTime.items.[INDEX]","typeLabel":"object"},"uniqueKey":"clicksOverTime","typeLabel":"object[]"},"topCountries":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"topCountries.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"topCountries.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"topCountries.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topCountries","typeLabel":"object[]"},"topRegions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"topRegions.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"topRegions.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"topRegions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topRegions","typeLabel":"object[]"},"topCities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"topCities.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"topCities.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"topCities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topCities","typeLabel":"object[]"},"topSources":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"topSources.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"topSources.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"topSources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topSources","typeLabel":"object[]"},"browserBreakdown":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"browserBreakdown.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"browserBreakdown.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"browserBreakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"browserBreakdown","typeLabel":"object[]"},"osBreakdown":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"osBreakdown.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"osBreakdown.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"osBreakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"osBreakdown","typeLabel":"object[]"},"deviceBreakdown":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"deviceBreakdown.items.[INDEX].name","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"deviceBreakdown.items.[INDEX].clicks","typeLabel":"integer"}},"uniqueKey":"deviceBreakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deviceBreakdown","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"totalClicks":123,"uniqueVisitors":123,"totalLinks":123,"uniqueVisitorRate":123,"referrers":123,"topLinks":[{}],"clicksOverTime":[{"date":"2026-08-01","clicks":123}],"topCountries":[{"name":"\u003cstring>","clicks":123}],"topRegions":[{"name":"\u003cstring>","clicks":123}],"topCities":[{"name":"\u003cstring>","clicks":123}],"topSources":[{"name":"\u003cstring>","clicks":123}],"browserBreakdown":[{"name":"\u003cstring>","clicks":123}],"osBreakdown":[{"name":"\u003cstring>","clicks":123}],"deviceBreakdown":[{"name":"\u003cstring>","clicks":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"76fdf6c3-4610-411e-847b-e39b3509eb31":{"description":"`startDate` or `endDate` is missing or not ISO 8601, or `startDate` is after `endDate`.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":400,"message":["startDate must be a valid ISO 8601 date"],"error":"Bad Request"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":["startDate must be a valid ISO 8601 date"],"error":"Bad Request"}}},"exampleType":"examples"}},"exampleType":"examples"},"ff35df54-6a21-4449-9618-bc29a86d3bfc":{"description":"Missing, malformed, expired or revoked credentials.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":401,"message":"Invalid or expired API key","error":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"message":"Invalid or expired API key","error":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"aaeee5d3-10f9-4c3d-b401-3edbc0b2a5b8":{"description":"The caller lacks `analytics.view`, the range starts before the plan's retention window, or the monthly click allowance is used up.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":403,"message":"You've used all your monthly clicks. Upgrade your plan to view analytics.","error":"Forbidden"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"message":"You've used all your monthly clicks. Upgrade your plan to view analytics.","error":"Forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"901afb3e-a739-409e-b4a4-3680151aff58":{"description":"Unexpected server error. Safe to retry with backoff.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":500,"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"statusCode":500,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4507dab4-7aee-4d72-b560-04992f6b9435":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","scopes":[]}},"48d713e5-206e-44b3-902f-aef17052ddd6":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Dashboard session token from `POST /auth/login`.","scopes":[]}}},"servers":{"42407d43-bba1-4aa5-8fc3-db9fec6cb642":{"url":"https://api.linkutm.com/api/v1","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Dashboard session token from `POST /auth/login`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Dashboard session token from `POST /auth/login`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"utm-e577acb5","siteName":"linkutm","title":"Workspace analytics - linkutm","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T06:26:57.894Z","originalFileLocation":"api/analytics/workspace.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve click analytics for the workspace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"linkutm\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Workspace analytics - linkutm\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve click analytics for the workspace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"linkutm\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.linkutm.com/api/analytics/workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://utm-e577acb5.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Workspace+analytics\u0026amp;description=Retrieve+click+analytics+for+the+workspace.\u0026amp;theme=765c4f27fee85dd05cdf6c69\u0026amp;signature=a36d0c2535223d70d9bec01d98e533b2ddf68c0e2ce31d8e5cf6d20bc010cec6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Workspace analytics - linkutm\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve click analytics for the workspace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://utm-e577acb5.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Workspace+analytics\u0026amp;description=Retrieve+click+analytics+for+the+workspace.\u0026amp;theme=765c4f27fee85dd05cdf6c69\u0026amp;signature=a36d0c2535223d70d9bec01d98e533b2ddf68c0e2ce31d8e5cf6d20bc010cec6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"linkutm\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff6200\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.linkutm.com/api/analytics/workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/analytics/workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.linkutm.com/#organization\",\"name\":\"linkutm\",\"url\":\"https://docs.linkutm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/light.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=1a0ed464d45ea6d3c2e41d0c7e5ffe1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.linkutm.com#website\",\"name\":\"linkutm\",\"url\":\"https://docs.linkutm.com\",\"publisher\":{\"@id\":\"https://docs.linkutm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.linkutm.com/api/analytics/workspace#webpage\",\"url\":\"https://docs.linkutm.com/api/analytics/workspace\",\"name\":\"Workspace analytics\",\"description\":\"Retrieve click analytics for the workspace.\",\"dateModified\":\"2026-10-05T06:26:57.894Z\",\"isPartOf\":{\"@id\":\"https://docs.linkutm.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.linkutm.com/api/analytics/workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.linkutm.com/api/analytics/workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Linkutm Links API\",\"item\":\"https://docs.linkutm.com/api/links/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspace analytics\",\"item\":\"https://docs.linkutm.com/api/analytics/workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.linkutm.com/api/analytics/workspace#apireference\",\"headline\":\"Workspace analytics\",\"name\":\"Workspace analytics\",\"description\":\"Retrieve click analytics for the workspace.\",\"url\":\"https://docs.linkutm.com/api/analytics/workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.linkutm.com/api/analytics/workspace#webpage\"},\"dateModified\":\"2026-10-05T06:26:57.894Z\",\"publisher\":{\"@id\":\"https://docs.linkutm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.linkutm.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"linkutm\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"linkutm","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock","href":"/changelog"}]},"tabs":[{"tab":"Links","pages":[{"title":"Links","href":"/getting-started/introduction"}]},{"tab":"Playbooks","pages":[{"title":"Playbooks","href":"/playbooks/utm-naming-convention"}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/common-issues"}]},{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Roles and permissions","href":"/api/roles"},{"title":"Errors","href":"/api/errors"},{"title":"Best practices","href":"/api/best-practices"}]},{"group":"Linkutm Links API","pages":[{"group":"Links","expanded":false,"pages":[{"title":"Create a link","openapi":"POST /links","href":"/api/links/create"},{"title":"List links","openapi":"GET /links","href":"/api/links/list"},{"title":"Retrieve a link","openapi":"GET /links/{id}","href":"/api/links/get"},{"title":"Update a link","openapi":"PATCH /links/{id}","href":"/api/links/update"},{"title":"Delete a link","openapi":"DELETE /links/{id}","href":"/api/links/delete"}]},{"group":"Domains","expanded":false,"pages":[{"title":"Create a domain","openapi":"POST /domains","href":"/api/domains/create"},{"title":"List domains","openapi":"GET /domains","href":"/api/domains/list"},{"title":"Verify a domain","openapi":"POST /domains/{id}/verify","href":"/api/domains/verify"},{"title":"Delete a domain","openapi":"DELETE /domains/{id}","href":"/api/domains/delete"},{"title":"Set the default domain","openapi":"POST /domains/{id}/set-default","href":"/api/domains/set-default"}]},{"group":"Folders","expanded":false,"pages":[{"title":"Create a folder","openapi":"POST /folders","href":"/api/folders/create"},{"title":"List folders","openapi":"GET /folders","href":"/api/folders/list"},{"title":"Update a folder","openapi":"PATCH /folders/{id}","href":"/api/folders/update"},{"title":"Delete a folder","openapi":"DELETE /folders/{id}","href":"/api/folders/delete"},{"title":"Set the default folder","openapi":"POST /folders/set-default","href":"/api/folders/set-default"}]},{"group":"Tags","expanded":false,"pages":[{"title":"Create a tag","openapi":"POST /tags","href":"/api/tags/create"},{"title":"List tags","openapi":"GET /tags","href":"/api/tags/list"},{"title":"Update a tag","openapi":"PATCH /tags/{id}","href":"/api/tags/update"},{"title":"Delete a tag","openapi":"DELETE /tags/{id}","description":"Delete a tag. The links carrying it are not affected.","href":"/api/tags/delete"}]},{"group":"Analytics","expanded":false,"pages":[{"title":"Workspace analytics","openapi":"GET /analytics","href":"/api/analytics/workspace"},{"title":"Link analytics","openapi":"GET /links/{linkId}/analytics","description":"Retrieve click analytics for a single link.","href":"/api/analytics/link"}]}]}]}]},"basePath":"","title":"Workspace analytics - linkutm","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}