Get the values of a timeseries-shaped custom metric
Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.
POST
/
api
/
analytics
/
custom-metrics
/
timeseries
Get the values of a timeseries-shaped custom metric
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"MentionLab","colors":{"primary":"#44c5e4","light":"#84E7FF","dark":"#2BA3C0"},"logo":{"light":"https://mintcdn.com/mentionlab/nh8jVOL0ziHLP1FN/logo/light.svg?fit=max\u0026auto=format\u0026n=nh8jVOL0ziHLP1FN\u0026q=85\u0026s=a72bc6fa216352f75d58b2e3b7386cfe","dark":"https://mintcdn.com/mentionlab/nh8jVOL0ziHLP1FN/logo/dark.svg?fit=max\u0026auto=format\u0026n=nh8jVOL0ziHLP1FN\u0026q=85\u0026s=259e3fab8bcb1cf98e3c0ceed6d1be55"},"favicon":"https://mintcdn.com/mentionlab/BZO4YAwLhtwgZHmy/favicon.svg?fit=max\u0026auto=format\u0026n=BZO4YAwLhtwgZHmy\u0026q=85\u0026s=12698a171eeb758c5ac182bbee13c650","background":{"color":{"dark":"#171717"}},"navbar":{"links":[{"href":"mailto:support@mentionlab.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.mentionlab.io"}},"footer":{"socials":{"github":"https://github.com/mentionlab","linkedin":"https://linkedin.com/company/mentionlab"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"globe","href":"https://status.mentionlab.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mentionlab","hasAudioNarration":false,"actualSubdomain":"mentionlab","customDomains":["docs.mentionlab.io"],"gitSource":{"type":"github","owner":"mentionlab","repo":"docs.mentionlab.io","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad6526a06204c9723e12ac5","collectionId":"6e99bfff-a9d2-4c15-8cbd-40e543ad8524","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad6526a06204c9723e12ac5"},"entitlements":{},"buildId":"6aecdb1f0887c8c72ee19927","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"REST API (legacy)","count":141},{"language":"default","tag":"Documentation","count":19},{"language":"default","tag":"Entities","count":14},{"language":"default","tag":"REST API v2 (alpha)","count":10},{"language":"default","tag":"Analytics - Sources","count":8},{"language":"default","tag":"Analytics - Tags","count":8},{"language":"default","tag":"Execution Tags","count":8},{"language":"default","tag":"Projects","count":8},{"language":"default","tag":"Source Topics","count":8},{"language":"default","tag":"Tags","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric","slug":"/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric","pageMetadata":{"title":"Get the values of a timeseries-shaped custom metric","description":"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/custom-metrics/timeseries","href":"/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric","autogeneratedByOpenApi":true},"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: \"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\"\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 the values of a timeseries-shaped custom metric","description":"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/custom-metrics/timeseries","href":"/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mentionlab/c64d9e021e887e3b/rybbit.js"],"openApiReferenceData":{"operation":{"description":"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.","operationId":"CustomMetricsController_timeseries","parameters":["b748ac20-01de-43ee-ab9f-ce3dabca4247"],"requestBody":"e1d642b0-dd35-4e91-9015-0112976af345","responses":{"200":"d07a06f7-55dc-4882-afb1-5b57fef1bf7f","400":"a69cdb0b-0297-48de-a9ca-817289bf6851","401":"4448abd5-43fa-4408-b5f4-e1ec280af6f0","403":"97fd848b-ec0c-4069-ada1-9c1e5bed0455"},"summary":"Get the values of a timeseries-shaped custom metric","tags":["Analytics - Custom Metrics"],"x-public-api":true,"method":"post","type":"path","servers":["fa889c93-3b44-477a-aee3-20a798406442"],"security":[],"path":"/api/analytics/custom-metrics/timeseries","baseUrlOptions":["https://api.mentionlab.io"],"title":"Get the values of a timeseries-shaped custom metric","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b748ac20-01de-43ee-ab9f-ce3dabca4247":{"name":"x-project-id","in":"header","description":"Project ID to specify the project context","required":true,"schema":{"type":"string","isRequired":true,"description":"Project ID to specify the project context","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"metric":{"type":"string","description":"Metric identifier (matches `id` returned by GET /analytics/custom-metrics)","example":"sample-metric-table","isRequired":true,"uniqueKey":"metric","typeLabel":"string"},"filter":{"type":"object","description":"Filter payload. Validated by the dispatcher against the metric-specific DTO class, which extends this base.","example":{"startDate":"2026-01-01","endDate":"2026-01-31"},"properties":{"startDate":{"type":"string","description":"Start date (inclusive)","example":"2025-01-01","uniqueKey":"filter.startDate","typeLabel":"string"},"endDate":{"type":"string","description":"End date (inclusive)","example":"2025-01-31","uniqueKey":"filter.endDate","typeLabel":"string"},"countries":{"description":"Filter by country codes","example":["BE","FR"],"type":"array","items":{"type":"string","uniqueKey":"filter.countries.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.countries","typeLabel":"string[]"},"languages":{"description":"Filter by language codes","example":["en","fr"],"type":"array","items":{"type":"string","uniqueKey":"filter.languages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.languages","typeLabel":"string[]"},"models":{"description":"Filter by AI models","example":["gpt-4o","claude-3-5-sonnet"],"type":"array","items":{"type":"string","uniqueKey":"filter.models.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.models","typeLabel":"string[]"},"queryIds":{"description":"Filter by query IDs","example":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"type":"array","items":{"type":"string","uniqueKey":"filter.queryIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.queryIds","typeLabel":"string[]"},"hasSources":{"type":"string","description":"Filter by source presence: \"sources\" (only with sources), \"no_sources\" (only without), \"all\" (no filter). Legacy true/false values are still accepted.","enum":["all","sources","no_sources"],"uniqueKey":"filter.hasSources","typeLabel":"enum\u003cstring>"},"hasShopping":{"type":"string","description":"Filter by shopping presence: \"shopping\" (only with shopping), \"no_shopping\" (only without), \"all\" (no filter). Legacy true/false values are still accepted.","enum":["all","shopping","no_shopping"],"uniqueKey":"filter.hasShopping","typeLabel":"enum\u003cstring>"},"hasAds":{"type":"string","description":"Filter by sponsored-ad presence: \"ads\" (only with ads), \"no_ads\" (only without), \"all\" (no filter). Legacy true/false values are still accepted.","enum":["all","ads","no_ads"],"uniqueKey":"filter.hasAds","typeLabel":"enum\u003cstring>"},"queryTagIds":{"description":"Filter by query tag IDs (numeric — bigint column)","example":["42"],"type":"array","items":{"type":"string","uniqueKey":"filter.queryTagIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.queryTagIds","typeLabel":"string[]"},"execTagIds":{"description":"Filter by execution tag IDs","example":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"type":"array","items":{"type":"string","uniqueKey":"filter.execTagIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.execTagIds","typeLabel":"string[]"},"queryTagGroupIds":{"description":"Filter by query tag group IDs — matches rows carrying any tag filed under a selected group. Combines with queryTagIds per queryTagMode.","example":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"type":"array","items":{"type":"string","uniqueKey":"filter.queryTagGroupIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.queryTagGroupIds","typeLabel":"string[]"},"execTagGroupIds":{"description":"Filter by execution tag group IDs — matches rows carrying any tag filed under a selected group. Combines with execTagIds per execTagMode.","example":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"type":"array","items":{"type":"string","uniqueKey":"filter.execTagGroupIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.execTagGroupIds","typeLabel":"string[]"},"queryTypes":{"type":"array","description":"Filter by query type. Include \"untyped\" to also match queries without a type. Results from since-deleted queries are excluded when this filter is set.","items":{"type":"string","enum":["comparative","informative","perception","untyped"],"uniqueKey":"filter.queryTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"filter.queryTypes","typeLabel":"enum\u003cstring>[]"},"queryTagMode":{"type":"string","description":"Query tag matching mode: \"and\" matches ALL tags (default, the dashboard's), \"or\" matches ANY tag.","enum":["and","or"],"uniqueKey":"filter.queryTagMode","typeLabel":"enum\u003cstring>"},"execTagMode":{"type":"string","description":"Execution tag matching mode: \"and\" matches ALL tags (default, the dashboard's), \"or\" matches ANY tag.","enum":["and","or"],"uniqueKey":"filter.execTagMode","typeLabel":"enum\u003cstring>"},"timezone":{"type":"string","deprecated":true,"description":"Deprecated and ignored. Date bounds and buckets are always UTC. Accepted for backward compatibility only.","example":"UTC","uniqueKey":"filter.timezone","typeLabel":"string"},"groupBy":{"type":"string","description":"Row grouping level for entity results. \"none\" = one row per entity, \"division\" = one row per division (entities not in a division get their own row), \"group\" = one row per top-level group (divisions roll up into their group). Defaults to \"none\".","enum":["none","division","group"],"uniqueKey":"filter.groupBy","typeLabel":"enum\u003cstring>"},"groupByEntityGroup":{"type":"boolean","description":"Deprecated — use groupBy instead. true is equivalent to groupBy=\"group\".","deprecated":true,"example":false,"uniqueKey":"filter.groupByEntityGroup","typeLabel":"boolean"},"showAllEntities":{"type":"boolean","description":"Include entities that have only ever been seen in a single AI response. These are mostly one-off extraction noise and are hidden by default.","example":false,"uniqueKey":"filter.showAllEntities","typeLabel":"boolean"},"entityTypes":{"type":"array","description":"Filter which entity types to include in results. Accepted values: \"owned\", \"primary\", \"competitor\". Defaults to all types when omitted.","example":["owned","primary","competitor"],"items":{"type":"string","enum":["owned","primary","competitor"],"uniqueKey":"filter.entityTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"filter.entityTypes","typeLabel":"enum\u003cstring>[]"},"entityIds":{"description":"Optional entity ids passed by the dashboard when a \"view as\" brand is active. Custom metrics typically ignore this and rely on the `highlight` rule to mark the targeted row instead.","example":["3fa85f64-5717-4562-b3fc-2c963f66afa6","7c9e6679-7425-40de-944b-e07fc1f90ae7"],"type":"array","items":{"type":"string","uniqueKey":"filter.entityIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.entityIds","typeLabel":"string[]"},"bucketSize":{"type":"string","description":"Time bucket granularity for trend metrics (day/week/month). Defaults to day. Ignored by table-shaped metrics.","enum":["day","week","month"],"example":"day","uniqueKey":"filter.bucketSize","typeLabel":"enum\u003cstring>"}},"uniqueKey":"filter","typeLabel":"object"}},"required":["metric"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"metric":"sample-metric-table","filter":{"startDate":"2026-01-01","endDate":"2026-01-31"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d07a06f7-55dc-4882-afb1-5b57fef1bf7f":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"metric":{"type":"string","isRequired":true,"uniqueKey":"metric","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"xAxis":{"type":"object","properties":{"key":{"type":"string","description":"Point key carrying this axis value","isRequired":true,"uniqueKey":"xAxis.key","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"xAxis.label","typeLabel":"string"},"type":{"type":"string","enum":["date","number","percent"],"description":"Axis value type. 'percent' is a number formatted with a '%' suffix.","isRequired":true,"uniqueKey":"xAxis.type","typeLabel":"enum\u003cstring>"}},"required":["key","label","type"],"isRequired":true,"uniqueKey":"xAxis","typeLabel":"object"},"yAxis":{"type":"object","properties":{"key":{"type":"string","description":"Point key carrying this axis value","isRequired":true,"uniqueKey":"yAxis.key","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"yAxis.label","typeLabel":"string"},"type":{"type":"string","enum":["date","number","percent"],"description":"Axis value type. 'percent' is a number formatted with a '%' suffix.","isRequired":true,"uniqueKey":"yAxis.type","typeLabel":"enum\u003cstring>"}},"required":["key","label","type"],"isRequired":true,"uniqueKey":"yAxis","typeLabel":"object"},"series":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Point key carrying this series value","isRequired":true,"uniqueKey":"series.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"series.items.[INDEX].label","typeLabel":"string"},"color":{"type":"string","description":"Color hint (semantic palette token, e.g. \"primary\")","uniqueKey":"series.items.[INDEX].color","typeLabel":"string"},"hidden":{"type":"boolean","description":"Auxiliary series carrying a component value (not for charting); generic renderers should skip it","uniqueKey":"series.items.[INDEX].hidden","typeLabel":"boolean"}},"required":["key","label"],"uniqueKey":"series.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"series","typeLabel":"object[]"},"points":{"type":"array","description":"Time-bucketed data; keys match xAxis.key + each series.key","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"points.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"points.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"points","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"}},"required":["metric","title","xAxis","yAxis","series","points"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"metric":"\u003cstring>","title":"\u003cstring>","xAxis":{"key":"\u003cstring>","label":"\u003cstring>","type":"date"},"yAxis":{"key":"\u003cstring>","label":"\u003cstring>","type":"date"},"series":[{"key":"\u003cstring>","label":"\u003cstring>","color":"\u003cstring>","hidden":true}],"points":[{}],"description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a69cdb0b-0297-48de-a9ca-817289bf6851":{"description":"The request failed validation — the body, query or path parameters are malformed or out of range.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error.","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Human-readable description of the error. Validation failures return an array of per-field validation errors instead of a single string.","example":"Validation failed","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Short name of the HTTP error.","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Validation failed","error":"Bad Request"}}},"exampleType":"generated"}},"exampleType":"generated"},"4448abd5-43fa-4408-b5f4-e1ec280af6f0":{"description":"The request is missing valid authentication credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error.","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Human-readable description of the error. Validation failures return an array of per-field validation errors instead of a single string.","example":"Validation failed","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Short name of the HTTP error.","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Validation failed","error":"Bad Request"}}},"exampleType":"generated"}},"exampleType":"generated"},"97fd848b-ec0c-4069-ada1-9c1e5bed0455":{"description":"The authenticated principal lacks the required permission, or access to the requested organisation/project.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error.","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Human-readable description of the error. Validation failures return an array of per-field validation errors instead of a single string.","example":"Validation failed","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Short name of the HTTP error.","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Validation failed","error":"Bad Request"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"fa889c93-3b44-477a-aee3-20a798406442":{"url":"https://api.mentionlab.io"}}},"originalFileLocation":"https://api.mentionlab.io/api/docs-json"},"subdomain":"mentionlab","siteName":"MentionLab","title":"Get the values of a timeseries-shaped custom metric - MentionLab","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T19:38:16.129Z","originalFileLocation":"api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric.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=\"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MentionLab\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_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/mentionlab/GPawiplNfjdcR17j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the values of a timeseries-shaped custom metric - MentionLab\">\u003cmeta data-mint-head property=\"og:description\" content=\"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MentionLab\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mentionlab.mintlify.site/_mintlify/api/og/v2?division=Analytics+-+Custom+Metrics\u0026amp;title=Get+the+values+of+a+timeseries-shaped+custom+metric\u0026amp;description=Runs+the+requested+timeseries-shaped+custom+metric+for+the+project+and+returns+its+results%3B+the+supplied+filter+is+validated+and+the+metric+must+be+granted+by+y\u0026amp;theme=21fc8b437c90d21db3f070e6\u0026amp;signature=f74cb8a15419d4141026d6d08323002699f4164869c6b986b3b96c8d5c21f372\">\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 the values of a timeseries-shaped custom metric - MentionLab\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mentionlab.mintlify.site/_mintlify/api/og/v2?division=Analytics+-+Custom+Metrics\u0026amp;title=Get+the+values+of+a+timeseries-shaped+custom+metric\u0026amp;description=Runs+the+requested+timeseries-shaped+custom+metric+for+the+project+and+returns+its+results%3B+the+supplied+filter+is+validated+and+the+metric+must+be+granted+by+y\u0026amp;theme=21fc8b437c90d21db3f070e6\u0026amp;signature=f74cb8a15419d4141026d6d08323002699f4164869c6b986b3b96c8d5c21f372\">\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/mentionlab/GPawiplNfjdcR17j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MentionLab\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#44c5e4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mentionlab.io/#organization\",\"name\":\"MentionLab\",\"url\":\"https://docs.mentionlab.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mentionlab/nh8jVOL0ziHLP1FN/logo/light.svg?fit=max\u0026auto=format\u0026n=nh8jVOL0ziHLP1FN\u0026q=85\u0026s=a72bc6fa216352f75d58b2e3b7386cfe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mentionlab.io#website\",\"name\":\"MentionLab\",\"url\":\"https://docs.mentionlab.io\",\"publisher\":{\"@id\":\"https://docs.mentionlab.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric#webpage\",\"url\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric\",\"name\":\"Get the values of a timeseries-shaped custom metric\",\"description\":\"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\",\"dateModified\":\"2026-11-05T19:38:16.129Z\",\"isPartOf\":{\"@id\":\"https://docs.mentionlab.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Analytics - Custom Metrics\",\"item\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/list-custom-metrics-the-current-organisation-has-access-to\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the values of a timeseries-shaped custom metric\",\"item\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric#apireference\",\"headline\":\"Get the values of a timeseries-shaped custom metric\",\"name\":\"Get the values of a timeseries-shaped custom metric\",\"description\":\"Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.\",\"url\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mentionlab.io/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric#webpage\"},\"dateModified\":\"2026-11-05T19:38:16.129Z\",\"publisher\":{\"@id\":\"https://docs.mentionlab.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mentionlab.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MentionLab\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"MentionLab","nav":{"global":{"anchors":[{"anchor":"Status","icon":"globe","href":"https://status.mentionlab.io"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"REST API (legacy)","groups":[{"group":"Overview","pages":[{"title":"Getting Started","href":"/rest-api/getting-started"},{"title":"Authentication","href":"/rest-api/authentication"},{"title":"Context Headers","href":"/rest-api/headers"},{"title":"MCP Server","href":"/rest-api/mcp-server"}]},{"group":"Projects","pages":[{"title":"Get a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/projects/{id}","href":"/api-reference/projects/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/projects/{id}","href":"/api-reference/projects/delete-a-project"},{"title":"List projects of the organisation","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/projects","href":"/api-reference/projects/list-projects-of-the-organisation"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/v1/projects/{id}","href":"/api-reference/projects/update-a-project"},{"title":"Update project settings","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/v1/projects/{id}/settings","href":"/api-reference/projects/update-project-settings"},{"title":"Countries and languages of a project’s locales","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/projects/{id}/locales","href":"/api-reference/projects/countries-and-languages-of-a-project’s-locales"},{"title":"Last job execution date for a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/projects/{id}/last-execution-date","href":"/api-reference/projects/last-job-execution-date-for-a-project"},{"title":"Distinct AI models used in a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/projects/{id}/models","href":"/api-reference/projects/distinct-ai-models-used-in-a-project"}]},{"group":"Queries","pages":[{"title":"Create queries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/queries/many","href":"/api-reference/queries/create-queries"},{"title":"Bulk-update tag associations for queries matched by text/language/country","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/queries/many/tags-only","href":"/api-reference/queries/bulk-update-tag-associations-for-queries-matched-by-textlanguagecountry"},{"title":"Get all queries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/queries/list","href":"/api-reference/queries/get-all-queries"},{"title":"Get total query count for a project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/queries/count","href":"/api-reference/queries/get-total-query-count-for-a-project"},{"title":"Get a query by ID","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/queries/{id}","href":"/api-reference/queries/get-a-query-by-id"},{"title":"Delete a query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/queries/{id}","href":"/api-reference/queries/delete-a-query"},{"title":"Update a query's type or tag associations","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/queries/{id}","href":"/api-reference/queries/update-a-querys-type-or-tag-associations"}]},{"group":"Analytics - Visibility","pages":[{"title":"Get per-entity visibility scores","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/visibility/entities","href":"/api-reference/analytics--visibility/get-per-entity-visibility-scores"},{"title":"Get brand share of voice","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/visibility/share-of-voice","href":"/api-reference/analytics--visibility/get-brand-share-of-voice"},{"title":"Per-entity visibility/position/sentiment timeseries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/visibility/timeseries","href":"/api-reference/analytics--visibility/per-entity-visibilitypositionsentiment-timeseries"}]},{"group":"Analytics - Tags","pages":[{"title":"Get per-tag visibility summary","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/summary","href":"/api-reference/analytics--tags/get-per-tag-visibility-summary"},{"title":"Get per-tag visibility timeseries matrix","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/matrix","href":"/api-reference/analytics--tags/get-per-tag-visibility-timeseries-matrix"},{"title":"Get per-tag stats with project brand metrics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/stats","href":"/api-reference/analytics--tags/get-per-tag-stats-with-project-brand-metrics"},{"title":"Get per-tag brand visibility broken down by model","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/models","href":"/api-reference/analytics--tags/get-per-tag-brand-visibility-broken-down-by-model"},{"title":"Get citation sources for a specific tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/sources","href":"/api-reference/analytics--tags/get-citation-sources-for-a-specific-tag"},{"title":"Get per-tag brand visibility over time","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/tags/trends","href":"/api-reference/analytics--tags/get-per-tag-brand-visibility-over-time"},{"title":"Entities detected for one or more tags","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/tags/entities","href":"/api-reference/analytics--tags/entities-detected-for-one-or-more-tags"},{"title":"Execution-tag response presence","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/tags/presence","href":"/api-reference/analytics--tags/execution-tag-response-presence"}]},{"group":"Analytics - Sources","pages":[{"title":"Per-domain citation rate and brand true reach","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/sources/domain-reach","href":"/api-reference/analytics--sources/per-domain-citation-rate-and-brand-true-reach"},{"title":"Citation breakdown by ICANN public suffix (TLD)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/sources/tld-breakdown","href":"/api-reference/analytics--sources/citation-breakdown-by-icann-public-suffix-tld"},{"title":"Source domains with citation \u0026 brand-reach metrics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/domains","href":"/api-reference/analytics--sources/source-domains-with-citation-\u0026-brand-reach-metrics"},{"title":"Citation breakdown by source type, group, relationship or controllability","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/breakdown","href":"/api-reference/analytics--sources/citation-breakdown-by-source-type-group-relationship-or-controllability"},{"title":"Timeseries of top source domains by citation share","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/domains/timeseries","href":"/api-reference/analytics--sources/timeseries-of-top-source-domains-by-citation-share"},{"title":"Entities found on a specific domain with true reach","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/domains/{sourceDomainId}/entities","href":"/api-reference/analytics--sources/entities-found-on-a-specific-domain-with-true-reach"},{"title":"Per-URL drill-down for a specific domain","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/domains/{sourceDomainId}/urls","href":"/api-reference/analytics--sources/per-url-drill-down-for-a-specific-domain"},{"title":"Queries that cited a specific URL on a domain","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/sources/domains/{sourceDomainId}/urls/queries","href":"/api-reference/analytics--sources/queries-that-cited-a-specific-url-on-a-domain"}]},{"group":"Analytics - Shopping","pages":[{"title":"Shopping overview stats","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/shopping/overview","href":"/api-reference/analytics--shopping/shopping-overview-stats"},{"title":"Brand visibility in shopping results over time","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/shopping/visibility-timeseries","href":"/api-reference/analytics--shopping/brand-visibility-in-shopping-results-over-time"},{"title":"List products for a merchant","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/shopping/merchants/{merchantId}/products","href":"/api-reference/analytics--shopping/list-products-for-a-merchant"},{"title":"List products with shopping metrics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/shopping/products","href":"/api-reference/analytics--shopping/list-products-with-shopping-metrics"},{"title":"List brands with shopping metrics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/shopping/brands","href":"/api-reference/analytics--shopping/list-brands-with-shopping-metrics"},{"title":"List merchants with citation metrics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/shopping/merchants","href":"/api-reference/analytics--shopping/list-merchants-with-citation-metrics"}]},{"group":"Analytics - Sentiment","pages":[{"title":"Get overall sentiment for project brand","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/sentiment/overview","href":"/api-reference/analytics--sentiment/get-overall-sentiment-for-project-brand"},{"title":"Get sentiment over time","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/sentiment/timeseries","href":"/api-reference/analytics--sentiment/get-sentiment-over-time"},{"title":"Get sentiment comparison across entities","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/sentiment/by-entity","href":"/api-reference/analytics--sentiment/get-sentiment-comparison-across-entities"}]},{"group":"Analytics - Queries","pages":[{"title":"Get source domains for a single query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/queries/{queryId}/sources","href":"/api-reference/analytics--queries/get-source-domains-for-a-single-query"},{"title":"Get entity stats for a single query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/queries/{queryId}/entities","href":"/api-reference/analytics--queries/get-entity-stats-for-a-single-query"},{"title":"Get top sources grouped by model for a single query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/queries/{queryId}/sources-by-model","href":"/api-reference/analytics--queries/get-top-sources-grouped-by-model-for-a-single-query"},{"title":"List AI responses for a query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/queries/{queryId}/results","href":"/api-reference/analytics--queries/list-ai-responses-for-a-query"},{"title":"Per-query statistics","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/queries/stats","href":"/api-reference/analytics--queries/per-query-statistics"}]},{"group":"Analytics - Models","pages":[{"title":"Get entity visibility breakdown per AI model","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/models/entity-visibility","href":"/api-reference/analytics--models/get-entity-visibility-breakdown-per-ai-model"},{"title":"Get platform details (visibility, ranking, share of voice) per AI model","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/models/platform-details","href":"/api-reference/analytics--models/get-platform-details-visibility-ranking-share-of-voice-per-ai-model"},{"title":"Get top entities for a specific AI model","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/models/drill-down/entities","href":"/api-reference/analytics--models/get-top-entities-for-a-specific-ai-model"},{"title":"Get top sources for a specific AI model","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/models/drill-down/sources","href":"/api-reference/analytics--models/get-top-sources-for-a-specific-ai-model"},{"title":"Per-AI-model metric timeseries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/models/timeseries","href":"/api-reference/analytics--models/per-ai-model-metric-timeseries"}]},{"group":"Analytics - Themes","pages":[{"title":"Get super-themes with their member themes (Brand Intelligence)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/super-themes","href":"/api-reference/analytics--themes/get-super-themes-with-their-member-themes-brand-intelligence"},{"title":"Get a paginated page of per-theme aggregates (Brand Perception \u0026 Intelligence)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/by-theme","href":"/api-reference/analytics--themes/get-a-paginated-page-of-per-theme-aggregates-brand-perception-\u0026-intelligence"},{"title":"Get per-brand stance distribution (Brand Intelligence)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/stance-distribution","href":"/api-reference/analytics--themes/get-per-brand-stance-distribution-brand-intelligence"},{"title":"Get the theme × brand sentiment matrix (Brand Intelligence)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/theme-entity-matrix","href":"/api-reference/analytics--themes/get-the-theme-×-brand-sentiment-matrix-brand-intelligence"},{"title":"Drill into a theme: its individual mentions with evidence spans","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/mentions","href":"/api-reference/analytics--themes/drill-into-a-theme:-its-individual-mentions-with-evidence-spans"},{"title":"Drill into a brand stance: the AI responses where it was chosen/negatively mentioned/…","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/entity-responses","href":"/api-reference/analytics--themes/drill-into-a-brand-stance:-the-ai-responses-where-it-was-chosennegatively-mentioned…"},{"title":"Fetch one AI response’s full text (for the in-context evidence viewer)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/themes/response","href":"/api-reference/analytics--themes/fetch-one-ai-response’s-full-text-for-the-in-context-evidence-viewer"}]},{"group":"Analytics - Ads","pages":[{"title":"Get per-brand ad share","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/ads/brands","href":"/api-reference/analytics--ads/get-per-brand-ad-share"},{"title":"Get ad placement mix by card format","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/ads/formats","href":"/api-reference/analytics--ads/get-ad-placement-mix-by-card-format"},{"title":"Get per-advertiser ad share","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/ads/advertisers","href":"/api-reference/analytics--ads/get-per-advertiser-ad-share"}]},{"group":"Entities","pages":[{"title":"Create a new entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities","href":"/api-reference/entities/create-a-new-entity"},{"title":"Get entity by ID","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/entities/{id}","href":"/api-reference/entities/get-entity-by-id"},{"title":"Delete an entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/entities/{id}","href":"/api-reference/entities/delete-an-entity"},{"title":"Update an entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/entities/{id}","href":"/api-reference/entities/update-an-entity"},{"title":"List entities with filters","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/list","href":"/api-reference/entities/list-entities-with-filters"},{"title":"Bulk update classification flags on multiple entities","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/entities/many","href":"/api-reference/entities/bulk-update-classification-flags-on-multiple-entities"},{"title":"Recompute the project-scoped source-domain relationships","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/recompute-relationships","href":"/api-reference/entities/recompute-the-project-scoped-source-domain-relationships"},{"title":"Import entities from a spreadsheet (create and update)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/import","href":"/api-reference/entities/import-entities-from-a-spreadsheet-create-and-update"},{"title":"Merge entities in bulk from a spreadsheet","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/import/merge","href":"/api-reference/entities/merge-entities-in-bulk-from-a-spreadsheet"},{"title":"Add an alias to an entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/{id}/aliases","href":"/api-reference/entities/add-an-alias-to-an-entity"},{"title":"Remove an alias from an entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/entities/{id}/aliases/{aliasId}","href":"/api-reference/entities/remove-an-alias-from-an-entity"},{"title":"Merge entities into a target","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/merge","href":"/api-reference/entities/merge-entities-into-a-target"},{"title":"Unmerge entities in bulk","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/unmerge","href":"/api-reference/entities/unmerge-entities-in-bulk"},{"title":"Unmerge a previously merged entity","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entities/{id}/unmerge","href":"/api-reference/entities/unmerge-a-previously-merged-entity"}]},{"group":"Organisations","pages":[{"title":"Get organisations for the current user","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/organisations","href":"/api-reference/organisations/get-organisations-for-the-current-user"}]},{"group":"Jobs","pages":[{"title":"Trigger an execution for all project queries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/jobs/trigger","href":"/api-reference/jobs/trigger-an-execution-for-all-project-queries"},{"title":"Get a job by ID","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/jobs/{id}","href":"/api-reference/jobs/get-a-job-by-id"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/jobs/list","href":"/api-reference/jobs/list-jobs"}]},{"group":"Job Executions","pages":[{"title":"Get full detail for a single run","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/job-executions/{id}","href":"/api-reference/job-executions/get-full-detail-for-a-single-run"}]},{"group":"Tags","pages":[{"title":"Create multiple tags","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/tags/many","href":"/api-reference/tags/create-multiple-tags"},{"title":"List tags","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/tags/list","href":"/api-reference/tags/list-tags"},{"title":"Get a tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/tags/{id}","href":"/api-reference/tags/get-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Move a selection of tags to a group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/tags/bulk/group","href":"/api-reference/tags/move-a-selection-of-tags-to-a-group"},{"title":"Link tags to queries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/tags/link/many","href":"/api-reference/tags/link-tags-to-queries"},{"title":"Unlink tags from queries","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/tags/unlink/many","href":"/api-reference/tags/unlink-tags-from-queries"}]},{"group":"Tag Groups","pages":[{"title":"List tag groups","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/tag-groups","href":"/api-reference/tag-groups/list-tag-groups"},{"title":"Create a tag group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/tag-groups","href":"/api-reference/tag-groups/create-a-tag-group"},{"title":"Delete a tag group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/v1/tag-groups/{id}","href":"/api-reference/tag-groups/delete-a-tag-group"},{"title":"Update a tag group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/v1/tag-groups/{id}","href":"/api-reference/tag-groups/update-a-tag-group"}]},{"group":"Execution Tags","pages":[{"title":"Create multiple execution tags","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/execution-tags/many","href":"/api-reference/execution-tags/create-multiple-execution-tags"},{"title":"Move a selection of execution tags to a group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/execution-tags/bulk/group","href":"/api-reference/execution-tags/move-a-selection-of-execution-tags-to-a-group"},{"title":"List all execution tags","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/execution-tags/list","href":"/api-reference/execution-tags/list-all-execution-tags"},{"title":"Get an execution tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/execution-tags/{id}","href":"/api-reference/execution-tags/get-an-execution-tag"},{"title":"Delete an execution tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/v1/execution-tags/{id}","href":"/api-reference/execution-tags/delete-an-execution-tag"},{"title":"Update an execution tag","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/v1/execution-tags/{id}","href":"/api-reference/execution-tags/update-an-execution-tag"},{"title":"Link execution tags to job executions","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/execution-tags/link/many","href":"/api-reference/execution-tags/link-execution-tags-to-job-executions"},{"title":"Unlink execution tags from job executions","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/execution-tags/unlink/many","href":"/api-reference/execution-tags/unlink-execution-tags-from-job-executions"}]},{"group":"Analytics - Custom Metrics","pages":[{"title":"List custom metrics the current organisation has access to","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/analytics/custom-metrics","href":"/api-reference/analytics--custom-metrics/list-custom-metrics-the-current-organisation-has-access-to"},{"title":"Get the values of a table-shaped custom metric","description":"Runs the requested table-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/custom-metrics/table","href":"/api-reference/analytics--custom-metrics/get-the-values-of-a-table-shaped-custom-metric"},{"title":"Get the values of a timeseries-shaped custom metric","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/analytics/custom-metrics/timeseries","href":"/api-reference/analytics--custom-metrics/get-the-values-of-a-timeseries-shaped-custom-metric"}]},{"group":"Theme Analysis","pages":[{"title":"Theme-analysis pipeline status for the project","description":"Read-only progress snapshot: whether an analysis is running (extraction/clustering in flight), pending (completed prompt runs queued for the next poll), or idle (up to date), plus the underlying counts.","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/projects/theme-analysis/status","href":"/api-reference/theme-analysis/theme-analysis-pipeline-status-for-the-project"},{"title":"Run theme analysis on the project's pending completed jobs","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/projects/theme-analysis/run-pending","href":"/api-reference/theme-analysis/run-theme-analysis-on-the-projects-pending-completed-jobs"}]},{"group":"Entity Types","pages":[{"title":"List the entity types a project can track","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/entity-types","href":"/api-reference/entity-types/list-the-entity-types-a-project-can-track"}]},{"group":"Entity Groups","pages":[{"title":"Create a new entity group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entity-groups","href":"/api-reference/entity-groups/create-a-new-entity-group"},{"title":"Get entity group by ID","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/entity-groups/{id}","href":"/api-reference/entity-groups/get-entity-group-by-id"},{"title":"Delete an entity group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/entity-groups/{id}","href":"/api-reference/entity-groups/delete-an-entity-group"},{"title":"Update an entity group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json patch /api/entity-groups/{id}","href":"/api-reference/entity-groups/update-an-entity-group"},{"title":"List entity groups","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/entity-groups/list","href":"/api-reference/entity-groups/list-entity-groups"},{"title":"Add entities to a group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json put /api/v1/entity-groups/{id}/entities","href":"/api-reference/entity-groups/add-entities-to-a-group"},{"title":"Remove entities from a group","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/v1/entity-groups/{id}/entities","href":"/api-reference/entity-groups/remove-entities-from-a-group"}]},{"group":"Source Categories","pages":[{"title":"List source categories","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/source-categories/list","href":"/api-reference/source-categories/list-source-categories"}]},{"group":"Analytics - Fan Outs","pages":[{"title":"Top fan-outs by occurrence","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/fan-outs","href":"/api-reference/analytics--fan-outs/top-fan-outs-by-occurrence"},{"title":"Fan-outs overview stats","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/fan-outs/overview","href":"/api-reference/analytics--fan-outs/fan-outs-overview-stats"},{"title":"Fan-out stats per query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/fan-outs/queries","href":"/api-reference/analytics--fan-outs/fan-out-stats-per-query"},{"title":"Fan-outs for a specific query","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/fan-outs/queries/{queryId}/fan-outs","href":"/api-reference/analytics--fan-outs/fan-outs-for-a-specific-query"}]},{"group":"Analytics - Social","pages":[{"title":"List YouTube videos cited in scope","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/videos","href":"/api-reference/analytics--social/list-youtube-videos-cited-in-scope"},{"title":"List YouTube channels cited in scope","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/channels","href":"/api-reference/analytics--social/list-youtube-channels-cited-in-scope"},{"title":"List YouTube performance by channel country","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/countries","href":"/api-reference/analytics--social/list-youtube-performance-by-channel-country"},{"title":"KPI summary for YouTube social in scope","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/kpis","href":"/api-reference/analytics--social/kpi-summary-for-youtube-social-in-scope"},{"title":"Timeseries of top 5 YouTube channels by citation share","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/channels/timeseries","href":"/api-reference/analytics--social/timeseries-of-top-5-youtube-channels-by-citation-share"},{"title":"Queries that cited a specific YouTube video","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/analytics/social/youtube/videos/{videoId}/queries","href":"/api-reference/analytics--social/queries-that-cited-a-specific-youtube-video"}]},{"group":"Source Topics","pages":[{"title":"Preview the sources a topic extraction would hit","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/source-topics/preview","href":"/api-reference/source-topics/preview-the-sources-a-topic-extraction-would-hit"},{"title":"Trigger topic extraction for the sources in scope","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/v1/source-topics/extract","href":"/api-reference/source-topics/trigger-topic-extraction-for-the-sources-in-scope"},{"title":"List topic-extraction runs for the project","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/source-topics/runs","href":"/api-reference/source-topics/list-topic-extraction-runs-for-the-project"},{"title":"Get a single topic-extraction run","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/source-topics/runs/{runId}","href":"/api-reference/source-topics/get-a-single-topic-extraction-run"},{"title":"Delete a topic-extraction run","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json delete /api/v1/source-topics/runs/{runId}","href":"/api-reference/source-topics/delete-a-topic-extraction-run"},{"title":"List the topics extracted for a run","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/source-topics/runs/{runId}/topics","href":"/api-reference/source-topics/list-the-topics-extracted-for-a-run"},{"title":"Content gap for a run (all topics)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/source-topics/runs/{runId}/content-gap","href":"/api-reference/source-topics/content-gap-for-a-run-all-topics"},{"title":"Content-gap detail for one topic (its sources)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/source-topics/runs/{runId}/content-gap/topics/{topicId}","href":"/api-reference/source-topics/content-gap-detail-for-one-topic-its-sources"}]},{"group":"Reference","pages":[{"title":"Provider/model restrictions (allowed countries)","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/reference/provider-restrictions","href":"/api-reference/reference/providermodel-restrictions-allowed-countries"},{"title":"Supported countries and languages allowlist","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json get /api/v1/reference/locales","href":"/api-reference/reference/supported-countries-and-languages-allowlist"}]},{"group":"Shopping Products","pages":[{"title":"List shopping products with merchant URLs","deprecated":null,"version":null,"openapi":"https://api.mentionlab.io/api/docs-json post /api/shopping-products/items","href":"/api-reference/shopping-products/list-shopping-products-with-merchant-urls"}]}]},{"tab":"REST API v2 (alpha)","pages":[{"title":"REST API v2 (alpha)","href":"/rest-api-v2/getting-started"}]}]},"basePath":"","title":"Get the values of a timeseries-shaped custom metric - MentionLab","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}