Responses over a window (the plan’s retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey’s first question of its kind.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Usertick","description":"Usertick documentation. Surveys, in-product feedback and reporting in one tool.","colors":{"primary":"#FF3C00","light":"#FF6A3A","dark":"#FF3C00"},"logo":{"light":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/light.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=9461af4bcd4a352017accf4accb120f9","dark":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/dark.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=38efcf251321688f80e92485435ec4cc"},"favicon":"https://mintcdn.com/usertick/Viv5pff-I3XvBVsI/favicon.svg?fit=max\u0026auto=format\u0026n=Viv5pff-I3XvBVsI\u0026q=85\u0026s=22114aee3fd94be42445bda4f6eac751","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://app.usertick.com/api/public/v1"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open dashboard","href":"https://app.usertick.com"}},"footer":{"socials":{"website":"https://usertick.com"}},"icons":{"library":"lucide"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"usertick","hasAudioNarration":false,"actualSubdomain":"usertick","customDomains":["docs.usertick.com"],"gitSource":{"type":"github","owner":"usertick","repo":"docs","deployBranch":"main","contentDirectory":"public","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae09581f01d62d5339237c5","collectionId":"0371a23d-9f7c-4f98-b020-39f01fefbc89","liveDeploymentHistoryId":"6ae09581f01d62d5339237c5","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae5c62997d8304171747d14","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Developers","count":56},{"language":"default","tag":"Documentation","count":44},{"language":"default","tag":"API reference","count":35},{"language":"default","tag":"Integrations","count":24},{"language":"default","tag":"REST API","count":12},{"language":"default","tag":"Build surveys","count":9},{"language":"default","tag":"Account","count":8},{"language":"default","tag":"Responses","count":7},{"language":"default","tag":"Install Usertick","count":7},{"language":"default","tag":"Webhook subscriptions","count":6}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developers/api/reference/get-metrics-summary","slug":"/developers/api/reference/get-metrics-summary","pageMetadata":{"title":"Get summary metrics","openapi":"api-reference/openapi.json GET /metrics/summary","description":"Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind.\n\nScopes: analytics:read.","href":"/developers/api/reference/get-metrics-summary"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Responses over a window (the plan’s retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey’s first question of its kind.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Scopes: analytics:read.\"\n })]\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":"Get summary metrics","openapi":"api-reference/openapi.json GET /metrics/summary","description":"Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind.\n\nScopes: analytics:read.","href":"/developers/api/reference/get-metrics-summary"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getMetricsSummary","summary":"Headline numbers","description":"Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind.\n\nScopes: analytics:read.","tags":["Metrics"],"x-scopes":["analytics:read"],"parameters":["787d3040-7540-4d4e-82a0-ed5228f19f87","9b954940-1487-4749-984b-fb76dee83bf7","540edc22-2cfc-4a1e-9475-49b3063f7ba0"],"responses":{"200":"55c84314-c74f-4973-af78-c2b56b02b3b0","400":"80e93597-ce39-4dfc-8868-d7aa4d8dcbf0","401":"2d7ccb07-fa79-4eb3-92f9-2a694f0694a7","403":"22d6c530-34c1-471f-a174-427a91976cca","404":"c2ab4618-4b91-45b0-9e57-0195a3c99c40","429":"6d47c238-594e-4e91-aa88-593df175d100","503":"44f8ed2d-729a-4ca8-8a99-03548657f1d0"},"method":"get","type":"path","servers":["1243191b-4fd0-4b4b-bffe-f8a7fd8119a9"],"security":["3a3e4305-85c4-459a-ba96-4b4e71fcd545","34a73146-0ccb-4780-9fd8-6624fbb3dcc4"],"path":"/metrics/summary","baseUrlOptions":["https://app.usertick.com/api/public/v1"],"title":"Headline numbers","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"787d3040-7540-4d4e-82a0-ed5228f19f87":{"name":"surveyId","in":"query","description":"One survey.","required":false,"schema":{"type":"string","format":"uuid","isRequired":false,"description":"One survey.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"9b954940-1487-4749-984b-fb76dee83bf7":{"name":"from","in":"query","description":"From this time (RFC 3339; UTC when no offset).","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"From this time (RFC 3339; UTC when no offset).","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"540edc22-2cfc-4a1e-9475-49b3063f7ba0":{"name":"to","in":"query","description":"Up to this time (RFC 3339; UTC when no offset). A date alone (2026-10-14) includes that whole UTC day.","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Up to this time (RFC 3339; UTC when no offset). A date alone (2026-10-14) includes that whole UTC day.","uniqueKey":"","typeLabel":"string\u003cdate-time>"}}},"responses":{"55c84314-c74f-4973-af78-c2b56b02b3b0":{"description":"The numbers.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"The credential's requests per minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"What is left of it now.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the credential's budget is full again (the bucket refills continuously).","schema":{"type":"integer"}},"X-RateLimit-Org-Limit":{"description":"Every credential of the organization together, per minute.","schema":{"type":"integer"}},"X-RateLimit-Org-Remaining":{"description":"What is left of the organization's budget.","schema":{"type":"integer"}},"X-RateLimit-Org-Reset":{"description":"Seconds until the organization's budget is full again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"surveyId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"surveyId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"surveyId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"surveyId","typeLabel":"string\u003cuuid> | null"},"from":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"from","typeLabel":"string\u003cdate-time> | null"},"to":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"to.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"to","typeLabel":"string\u003cdate-time> | null"},"responses":{"type":"integer","isRequired":true,"uniqueKey":"responses","typeLabel":"integer"},"nps":{"oneOf":[{"type":"object","required":["value","sampleSize","questionId"],"properties":{"value":{"type":"number","description":"Unrounded: nps from -100 to 100, csat the percent of ratings at or above the satisfied rating (ceil(0.8 × scale)), ces and avgScore the average answer. Round once where it is shown.","isRequired":true,"uniqueKey":"nps.oneOf.0.value","typeLabel":"number"},"sampleSize":{"type":"integer","isRequired":true,"uniqueKey":"nps.oneOf.0.sampleSize","typeLabel":"integer"},"questionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"nps.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"nps.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nps.oneOf.0.questionId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"nps.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"nps.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nps","typeLabel":"object | null"},"csat":{"oneOf":[{"type":"object","required":["value","sampleSize","questionId"],"properties":{"value":{"type":"number","description":"Unrounded: nps from -100 to 100, csat the percent of ratings at or above the satisfied rating (ceil(0.8 × scale)), ces and avgScore the average answer. Round once where it is shown.","isRequired":true,"uniqueKey":"csat.oneOf.0.value","typeLabel":"number"},"sampleSize":{"type":"integer","isRequired":true,"uniqueKey":"csat.oneOf.0.sampleSize","typeLabel":"integer"},"questionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"csat.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"csat.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"csat.oneOf.0.questionId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"csat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"csat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"csat","typeLabel":"object | null"},"ces":{"oneOf":[{"type":"object","required":["value","sampleSize","questionId"],"properties":{"value":{"type":"number","description":"Unrounded: nps from -100 to 100, csat the percent of ratings at or above the satisfied rating (ceil(0.8 × scale)), ces and avgScore the average answer. Round once where it is shown.","isRequired":true,"uniqueKey":"ces.oneOf.0.value","typeLabel":"number"},"sampleSize":{"type":"integer","isRequired":true,"uniqueKey":"ces.oneOf.0.sampleSize","typeLabel":"integer"},"questionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ces.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ces.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ces.oneOf.0.questionId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"ces.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"ces.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ces","typeLabel":"object | null"},"avgScore":{"oneOf":[{"type":"object","required":["value","sampleSize","questionId"],"properties":{"value":{"type":"number","description":"Unrounded: nps from -100 to 100, csat the percent of ratings at or above the satisfied rating (ceil(0.8 × scale)), ces and avgScore the average answer. Round once where it is shown.","isRequired":true,"uniqueKey":"avgScore.oneOf.0.value","typeLabel":"number"},"sampleSize":{"type":"integer","isRequired":true,"uniqueKey":"avgScore.oneOf.0.sampleSize","typeLabel":"integer"},"questionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"avgScore.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"avgScore.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"avgScore.oneOf.0.questionId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"avgScore.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"avgScore.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"avgScore","typeLabel":"object | null"}},"required":["surveyId","from","to","responses","nps","csat","ces","avgScore"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"surveyId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","from":"2026-09-30T10:00:00.000Z","to":"2026-09-30T10:00:00.000Z","responses":123,"nps":{"value":123,"sampleSize":123,"questionId":"\u003cstring>"},"csat":{"value":123,"sampleSize":123,"questionId":"\u003cstring>"},"ces":{"value":123,"sampleSize":123,"questionId":"\u003cstring>"},"avgScore":{"value":123,"sampleSize":123,"questionId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"80e93597-ce39-4dfc-8868-d7aa4d8dcbf0":{"description":"The request isn't valid. Codes: PUB-001-003, PUB-001-007.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"PUB-001-003":{"title":"PUB-001-003","value":{"statusCode":400,"success":false,"code":"PUB-001-003","message":"Send times in RFC 3339, such as 2026-09-30T10:00:00.000Z.","data":null}},"PUB-001-007":{"title":"PUB-001-007","value":{"statusCode":400,"success":false,"code":"PUB-001-007","message":"The start of the window must come before its end.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"2d7ccb07-fa79-4eb3-92f9-2a694f0694a7":{"description":"No credential, or one that is invalid, expired or revoked. Codes: APK-004-001, APK-004-002.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-001":{"title":"APK-004-001","value":{"statusCode":401,"success":false,"code":"APK-004-001","message":"Send an API key or an access token in the Authorization header.","data":null}},"APK-004-002":{"title":"APK-004-002","value":{"statusCode":401,"success":false,"code":"APK-004-002","message":"The API key or access token is invalid, expired or revoked. Connect again with a valid one.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"22d6c530-34c1-471f-a174-427a91976cca":{"description":"The credential lacks a scope this endpoint needs, the plan does not include the API (API keys on Pro and up, apps such as Zapier on Starter and up), or an app's member lacks the permission. Codes: APK-004-004, APK-004-005, APK-004-008, AUTHZ-001-002.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-004":{"title":"APK-004-004","value":{"statusCode":403,"success":false,"code":"APK-004-004","message":"This API key or app doesn't have permission for this request. Grant it the required scope.","data":null}},"APK-004-005":{"title":"APK-004-005","value":{"statusCode":403,"success":false,"code":"APK-004-005","message":"Your plan doesn't include API keys or the MCP server. To use them, upgrade to Pro or higher.","data":null}},"APK-004-008":{"title":"APK-004-008","value":{"statusCode":403,"success":false,"code":"APK-004-008","message":"Your plan doesn't include apps that use the API, such as Zapier. To use them, upgrade to Starter or higher.","data":null}},"AUTHZ-001-002":{"title":"AUTHZ-001-002","value":{"statusCode":403,"success":false,"code":"AUTHZ-001-002","message":"Your role doesn't have the required permission.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"c2ab4618-4b91-45b0-9e57-0195a3c99c40":{"description":"The resource couldn't be found. Codes: APK-006-005.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-006-005":{"title":"APK-006-005","value":{"statusCode":404,"success":false,"code":"APK-006-005","message":"The survey couldn't be found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"6d47c238-594e-4e91-aa88-593df175d100":{"description":"Over the credential's or the organization's budget, or over the per-address limit that is checked before the credential (GEN-429-001, without X-RateLimit headers). Codes: APK-004-003, APK-004-006, GEN-429-001.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-003":{"title":"APK-004-003","value":{"statusCode":429,"success":false,"code":"APK-004-003","message":"This API key or app sent too many requests. Wait a minute and try again.","data":null}},"APK-004-006":{"title":"APK-004-006","value":{"statusCode":429,"success":false,"code":"APK-004-006","message":"Your organization sent too many API requests. Wait a minute and try again.","data":null}},"GEN-429-001":{"title":"GEN-429-001","value":{"statusCode":429,"success":false,"code":"GEN-429-001","message":"Too many requests were sent. Wait a minute and try again.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"44f8ed2d-729a-4ca8-8a99-03548657f1d0":{"description":"A data store didn't respond. Try again. Codes: ANL-001-503.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"ANL-001-503":{"title":"ANL-001-503","value":{"statusCode":503,"success":false,"code":"ANL-001-503","message":"Analytics storage is unavailable right now. Try again in a moment.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3a3e4305-85c4-459a-ba96-4b4e71fcd545":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"}},"34a73146-0ccb-4780-9fd8-6624fbb3dcc4":{"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"}}},"servers":{"1243191b-4fd0-4b4b-bffe-f8a7fd8119a9":{"url":"https://app.usertick.com/api/public/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"},"schema":{"title":"X-Api-Key","type":"string","description":"The API key, for clients that cannot send Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyHeader","name":"X-Api-Key"}],"title":"apiKeyHeader"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"usertick","siteName":"Usertick","title":"Get summary metrics - Usertick","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T06:32:59.190Z","originalFileLocation":"developers/api/reference/get-metrics-summary.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=\"Responses over a window (the plan\u0026#x27;s retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey\u0026#x27;s first question of its kind. Scopes: analytics:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Usertick\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get summary metrics - Usertick\">\u003cmeta data-mint-head property=\"og:description\" content=\"Responses over a window (the plan\u0026#x27;s retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey\u0026#x27;s first question of its kind. Scopes: analytics:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Usertick\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usertick.com/developers/api/reference/get-metrics-summary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://usertick.mintlify.app/_mintlify/api/og/v2?division=Metrics\u0026amp;title=Get+summary+metrics\u0026amp;description=Responses+over+a+window+%28the+plan%27s+retention+window+at+most%29%2C+and+for+one+survey+its+NPS%2C+CSAT%2C+CES+and+average+score%2C+each+read+from+the+survey%27s+first+questi\u0026amp;theme=47d2035b061bb461b6b02c51\u0026amp;signature=000efee08fccebdf669767fd5e66cd2619bb6199151ab7951ceee54024af5d7a\">\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=\"Get summary metrics - Usertick\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Responses over a window (the plan\u0026#x27;s retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey\u0026#x27;s first question of its kind. Scopes: analytics:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://usertick.mintlify.app/_mintlify/api/og/v2?division=Metrics\u0026amp;title=Get+summary+metrics\u0026amp;description=Responses+over+a+window+%28the+plan%27s+retention+window+at+most%29%2C+and+for+one+survey+its+NPS%2C+CSAT%2C+CES+and+average+score%2C+each+read+from+the+survey%27s+first+questi\u0026amp;theme=47d2035b061bb461b6b02c51\u0026amp;signature=000efee08fccebdf669767fd5e66cd2619bb6199151ab7951ceee54024af5d7a\">\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/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Usertick\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF3C00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usertick.com/developers/api/reference/get-metrics-summary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api/reference/get-metrics-summary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usertick.com/#organization\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/light.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=9461af4bcd4a352017accf4accb120f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usertick.com#website\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"publisher\":{\"@id\":\"https://docs.usertick.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary#webpage\",\"url\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary\",\"name\":\"Get summary metrics\",\"description\":\"Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind. Scopes: analytics:read.\",\"dateModified\":\"2026-10-24T06:32:59.190Z\",\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get summary metrics\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary#apireference\",\"headline\":\"Get summary metrics\",\"name\":\"Get summary metrics\",\"description\":\"Responses over a window (the plan's retention window at most), and for one survey its NPS, CSAT, CES and average score, each read from the survey's first question of its kind. Scopes: analytics:read.\",\"url\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/get-metrics-summary#webpage\"},\"dateModified\":\"2026-10-24T06:32:59.190Z\",\"publisher\":{\"@id\":\"https://docs.usertick.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Usertick\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Usertick","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Developers","groups":[{"group":"JavaScript SDK","pages":[{"title":"JavaScript SDK","sidebarTitle":"Overview","href":"/developers/sdk/overview"},{"title":"SDK reference","href":"/developers/sdk/reference"},{"title":"SDK events","href":"/developers/sdk/events"}]},{"group":"REST API","pages":[{"title":"REST API","sidebarTitle":"Overview","href":"/developers/api/overview"},{"title":"Authentication","href":"/developers/api/authentication"},{"title":"OAuth for apps","href":"/developers/api/oauth"},{"title":"The Response resource","sidebarTitle":"The Response resource","href":"/developers/api/response-object"},{"title":"Pagination","href":"/developers/api/pagination"},{"title":"Errors","href":"/developers/api/errors"},{"title":"Rate limits","href":"/developers/api/rate-limits"},{"title":"Idempotency","href":"/developers/api/idempotency"},{"title":"Versioning","href":"/developers/api/versioning"},{"title":"Erase personal data","href":"/developers/api/erasure"},{"title":"Metrics","href":"/developers/api/metrics"},{"title":"Download files","href":"/developers/api/attachments"}]},{"group":"API reference","pages":[{"group":"Account","pages":[{"title":"Get the current credential","openapi":"api-reference/openapi.json GET /me","href":"/developers/api/reference/get-me"}]},{"group":"Surveys","pages":[{"title":"List surveys","openapi":"api-reference/openapi.json GET /surveys","href":"/developers/api/reference/list-surveys"},{"title":"Get a survey","openapi":"api-reference/openapi.json GET /surveys/{surveyId}","href":"/developers/api/reference/get-survey"},{"title":"Pause a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/pause","href":"/developers/api/reference/pause-survey"},{"title":"Resume a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/resume","href":"/developers/api/reference/resume-survey"},{"title":"List sites","openapi":"api-reference/openapi.json GET /sites","href":"/developers/api/reference/list-sites"}]},{"group":"Responses","pages":[{"title":"List responses","openapi":"api-reference/openapi.json GET /responses","href":"/developers/api/reference/list-responses"},{"title":"List recent responses","openapi":"api-reference/openapi.json GET /responses/recent","href":"/developers/api/reference/list-recent-responses"},{"title":"Get a response","openapi":"api-reference/openapi.json GET /responses/{responseId}","href":"/developers/api/reference/get-response"},{"title":"Update a response","openapi":"api-reference/openapi.json PATCH /responses/{responseId}","href":"/developers/api/reference/update-response"},{"title":"List the analysis tree","openapi":"api-reference/openapi.json GET /themes","href":"/developers/api/reference/list-themes"},{"title":"List members","openapi":"api-reference/openapi.json GET /members","href":"/developers/api/reference/list-members"},{"title":"Download a respondent's file","openapi":"api-reference/openapi.json GET /responses/{responseId}/attachments/{attachmentId}","href":"/developers/api/reference/get-attachment"}]},{"group":"Notes","pages":[{"title":"List notes","openapi":"api-reference/openapi.json GET /responses/{responseId}/comments","href":"/developers/api/reference/list-comments"},{"title":"Add a note","openapi":"api-reference/openapi.json POST /responses/{responseId}/comments","href":"/developers/api/reference/add-comment"},{"title":"Edit a note","openapi":"api-reference/openapi.json PATCH /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/edit-comment"},{"title":"Delete a note","openapi":"api-reference/openapi.json DELETE /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/delete-comment"}]},{"group":"Erasure","pages":[{"title":"Erase a response","openapi":"api-reference/openapi.json DELETE /responses/{responseId}","href":"/developers/api/reference/delete-response"},{"title":"Erase a respondent","openapi":"api-reference/openapi.json POST /responses/erase","href":"/developers/api/reference/erase-respondent"},{"title":"Get a job","openapi":"api-reference/openapi.json GET /jobs/{jobId}","description":"A background job of the organization and how far it got. A failed run is tried again up to five times.\n\nScopes: responses:delete.","href":"/developers/api/reference/get-job"}]},{"group":"Metrics","pages":[{"title":"Get summary metrics","openapi":"api-reference/openapi.json GET /metrics/summary","href":"/developers/api/reference/get-metrics-summary"},{"title":"Get a metric over time","openapi":"api-reference/openapi.json GET /metrics/timeseries","description":"One point per day, week or month (UTC), oldest first.\n\nScopes: analytics:read.","href":"/developers/api/reference/get-metrics-time-series"},{"title":"Get a breakdown","openapi":"api-reference/openapi.json GET /metrics/breakdown","href":"/developers/api/reference/get-metrics-breakdown"}]},{"group":"Webhook subscriptions","pages":[{"title":"List subscriptions","openapi":"api-reference/openapi.json GET /webhooks","href":"/developers/api/reference/list-webhooks"},{"title":"Subscribe a URL","openapi":"api-reference/openapi.json POST /webhooks/subscribe","href":"/developers/api/reference/subscribe-webhook"},{"title":"List workflow Zapier steps","openapi":"api-reference/openapi.json GET /workflows/zapier-steps","href":"/developers/api/reference/list-zapier-steps"},{"title":"Unsubscribe a URL","openapi":"api-reference/openapi.json DELETE /webhooks/{webhookId}","href":"/developers/api/reference/unsubscribe-webhook"},{"title":"List deliveries","openapi":"api-reference/openapi.json GET /webhooks/{webhookId}/deliveries","href":"/developers/api/reference/list-deliveries"},{"title":"Resend a delivery","openapi":"api-reference/openapi.json POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/developers/api/reference/resend-delivery"}]},{"group":"Webhook events","pages":[{"title":"response.created","openapi":"api-reference/openapi.json webhook response.created","href":"/developers/api/reference/webhook-response-created"},{"title":"response.analyzed","openapi":"api-reference/openapi.json webhook response.analyzed","href":"/developers/api/reference/webhook-response-analyzed"},{"title":"response.status_changed","openapi":"api-reference/openapi.json webhook response.status_changed","href":"/developers/api/reference/webhook-response-status-changed"},{"title":"response.classification_corrected","openapi":"api-reference/openapi.json webhook response.classification_corrected","href":"/developers/api/reference/webhook-response-classification-corrected"},{"title":"response.urgent","openapi":"api-reference/openapi.json webhook response.urgent","href":"/developers/api/reference/webhook-response-urgent"},{"title":"theme.spiking","openapi":"api-reference/openapi.json webhook theme.spiking","href":"/developers/api/reference/webhook-theme-spiking"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/developers/webhooks/overview"},{"title":"Webhook events","href":"/developers/webhooks/events"},{"title":"Verify signatures","href":"/developers/webhooks/verify"},{"title":"Delivery and retries","href":"/developers/webhooks/delivery"},{"title":"Rotate a secret","href":"/developers/webhooks/rotation"}]},{"group":"MCP","pages":[{"title":"MCP server","href":"/developers/mcp"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/surveys"}]}]},"basePath":"","title":"Get summary metrics - Usertick","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}