Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.
The views that the campaign counts: views on clips that can earn, from the countries that the campaign pays for. This is the number that the campaign dashboard shows.
Required range: -9007199254740991 <= x <= 9007199254740991
The views left after the most that one clip can earn, at the highest rate. This is the last stage of the funnel. On a paused campaign it can be more than paid_views.
Required range: -9007199254740991 <= x <= 9007199254740991
The counted views that nobody pays for. A view is free when its clip reached the most that one clip can earn, when the budget is used up, or when it came after the campaign paused.
Required range: -9007199254740991 <= x <= 9007199254740991
The rate the campaign pays for 1,000 counted views, in cents, without free views. When clips were paid at different rates, this is the average. Null when no view is counted yet.
Required range: -9007199254740991 <= x <= 9007199254740991
The spend for each 1,000 views, in cents, over the views in effective_cpm_views. Free views make it lower than selected_cpm_cents. Null when there are no views yet.
Required range: -9007199254740991 <= x <= 9007199254740991
The views that effective_cpm_cents divides the spend by: every view, from every country, on the clips that can earn. With geo targeting on, this is more than total_views.
Required range: -9007199254740991 <= x <= 9007199254740991
engagements divided by engagement_views, as a fraction to four decimal places. For example, 0.0544 is 5.44%. Null when there are no views yet.
Example:
0.0544
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClipStake Developer Docs","description":"Developer docs for the ClipStake APIs. The Console API tracks Instagram and X media. The Agency API reads your campaign data. The Creator API submits your clips.","colors":{"primary":"#CE1111","light":"#E34A4A","dark":"#7C0A0A"},"logo":{"light":"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-light.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=7681e523e43fb1457a67bd8fef8635d9","dark":"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-dark.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=eb665430b972a58134b8c16b137c3230"},"favicon":"https://mintcdn.com/clipstake-618eb5ee/l5j-30uYBX6r2Dqv/favicon.svg?fit=max\u0026auto=format\u0026n=l5j-30uYBX6r2Dqv\u0026q=85\u0026s=f48b590257eaf8c7112fb416b1cbe4e4","appearance":{"default":"system"},"background":{"color":{"light":"#FFFBFA","dark":"#000000"}},"navbar":{"links":[{"href":"https://status.clipstake.com","label":"Status"}],"primary":{"type":"button","label":"Open Console","href":"https://console.clipstake.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clipstake-618eb5ee","hasAudioNarration":false,"actualSubdomain":"clipstake-618eb5ee","customDomains":["docs.clipstake.com"],"gitSource":{"type":"github","owner":"clipstake","repo":"bedrock","deployBranch":"prod","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"}},"buildId":"6aeb6abedfc350f7e13f9bfb","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":72},{"language":"default","tag":"Console API","count":60},{"language":"default","tag":"Submissions","count":28},{"language":"default","tag":"Developer Guides","count":19},{"language":"default","tag":"Instagram","count":17},{"language":"default","tag":"Agency API","count":15},{"language":"default","tag":"X","count":14},{"language":"default","tag":"YouTube","count":14},{"language":"default","tag":"Brand API","count":13},{"language":"default","tag":"Accounts","count":13}]},"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":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"brand-api/api-reference/campaigns/get-campaign-metrics","slug":"/brand-api/api-reference/campaigns/get-campaign-metrics","pageMetadata":{"title":"Get campaign metrics","description":"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.","deprecated":null,"version":null,"sidebarTitle":"Get campaign metrics","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}/metrics","href":"/brand-api/api-reference/campaigns/get-campaign-metrics","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: \"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\"\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 campaign metrics","description":"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.","deprecated":null,"version":null,"sidebarTitle":"Get campaign metrics","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}/metrics","href":"/brand-api/api-reference/campaigns/get-campaign-metrics","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/clipstake-618eb5ee/39a3d3e929151a04/navbar-cta.js","/_mintlify/custom/clipstake-618eb5ee/53f114a48bb87823/hero-shader.js"],"openApiReferenceData":{"operation":{"operationId":"campaigns-metrics","summary":"Get campaign metrics","description":"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.","tags":["Campaigns"],"security":["ee2f83b8-2e1e-4279-ab92-5619ecc13fd8"],"parameters":["3d8bedc3-ed18-42f2-9d6f-ee08d23ec9b1"],"responses":{"200":"5d44e578-fd78-46c0-989b-3b226c4469b5","401":"93fd07e3-121b-47eb-8701-e74e45b106c2","404":"dabf3292-a8bc-439c-ad78-782f078aa6df","500":"d6f85c8f-0669-476d-b028-d35345379bf3"},"x-mint":{"href":"/brand-api/api-reference/campaigns/get-campaign-metrics"},"method":"get","type":"path","servers":["32291b76-29b0-4420-94cf-a5e5f1ab5194"],"path":"/campaigns/{campaign_id}/metrics","baseUrlOptions":["https://app.clipstake.com/api/v1/brand"],"title":"Get campaign metrics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3d8bedc3-ed18-42f2-9d6f-ee08d23ec9b1":{"in":"path","name":"campaign_id","schema":{"type":"string","description":"Campaign ID. Format: cmp_ followed by 32 lowercase hexadecimal characters.","example":"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Campaign ID. Format: cmp_ followed by 32 lowercase hexadecimal characters."}},"responses":{"5d44e578-fd78-46c0-989b-3b226c4469b5":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"campaign_id":{"type":"string","pattern":"^cmp_[0-9a-f]{32}$","description":"Campaign ID.","example":"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60","isRequired":true,"uniqueKey":"campaign_id","typeLabel":"string"},"geo_enabled":{"type":"boolean","description":"True when the campaign pays by the country of the viewers. Then the counted views are only the views from the countries that the campaign pays for.","example":false,"isRequired":true,"uniqueKey":"geo_enabled","typeLabel":"boolean"},"total_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The views that the campaign counts: views on clips that can earn, from the countries that the campaign pays for. This is the number that the campaign dashboard shows.","example":1180000,"isRequired":true,"uniqueKey":"total_views","typeLabel":"integer"},"all_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Every view on every clip of the campaign, including clips that cannot earn.","example":1250000,"isRequired":true,"uniqueKey":"all_views","typeLabel":"integer"},"payable_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The views left after the most that one clip can earn, at the highest rate. This is the last stage of the funnel. On a paused campaign it can be more than `paid_views`.","example":1100000,"isRequired":true,"uniqueKey":"payable_views","typeLabel":"integer"},"funnel":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","description":"`total`: every view on every clip. `eligible`: views on clips that can earn. `targeted`: views from the countries that the campaign pays for (geo targeting only). `priced`: the views that have a rate, counted at the highest rate of the campaign. `capped`: the same views, after the most that one clip can earn. More values can be added.","example":"eligible","isRequired":true,"uniqueKey":"funnel.items.[INDEX].stage","typeLabel":"string"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The views that are left after this stage. Each stage is never more than the stage before it.","example":1180000,"isRequired":true,"uniqueKey":"funnel.items.[INDEX].views","typeLabel":"integer"}},"required":["stage","views"],"additionalProperties":false,"description":"One stage of the views funnel.","uniqueKey":"funnel.items.[INDEX]","typeLabel":"object"},"description":"The views at each stage, from all views to `payable_views`. The stages are in order.","isRequired":true,"uniqueKey":"funnel","typeLabel":"object[]"},"goal_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The views that the full budget pays for, at the highest rate of the campaign. 0 when the campaign has no rate.","example":2500000,"isRequired":true,"uniqueKey":"goal_views","typeLabel":"integer"},"spend_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The amount that the counted views earned, in cents. It is never more than the budget. It includes amounts that are not paid out yet.","example":220000,"isRequired":true,"uniqueKey":"spend_cents","typeLabel":"integer"},"paid_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The counted views that the spend pays for.","example":1100000,"isRequired":true,"uniqueKey":"paid_views","typeLabel":"integer"},"free_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The counted views that nobody pays for. A view is free when its clip reached the most that one clip can earn, when the budget is used up, or when it came after the campaign paused.","example":80000,"isRequired":true,"uniqueKey":"free_views","typeLabel":"integer"},"selected_cpm_cents":{"oneOf":[{"type":"integer","description":"The rate the campaign pays for 1,000 counted views, in cents, without free views. When clips were paid at different rates, this is the average. Null when no view is counted yet.","maximum":9007199254740991,"minimum":-9007199254740991,"example":200,"isRequired":true,"uniqueKey":"selected_cpm_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The rate the campaign pays for 1,000 counted views, in cents, without free views. When clips were paid at different rates, this is the average. Null when no view is counted yet.","example":200,"isRequired":true,"uniqueKey":"selected_cpm_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"selected_cpm_cents","typeLabel":"integer | null"},"selected_cpm_is_average":{"type":"boolean","description":"True when the counted views were paid at more than one rate, so `selected_cpm_cents` is an average.","example":false,"isRequired":true,"uniqueKey":"selected_cpm_is_average","typeLabel":"boolean"},"effective_cpm_cents":{"oneOf":[{"type":"integer","description":"The spend for each 1,000 views, in cents, over the views in `effective_cpm_views`. Free views make it lower than `selected_cpm_cents`. Null when there are no views yet.","maximum":9007199254740991,"minimum":-9007199254740991,"example":176,"isRequired":true,"uniqueKey":"effective_cpm_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The spend for each 1,000 views, in cents, over the views in `effective_cpm_views`. Free views make it lower than `selected_cpm_cents`. Null when there are no views yet.","example":176,"isRequired":true,"uniqueKey":"effective_cpm_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"effective_cpm_cents","typeLabel":"integer | null"},"effective_cpm_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The views that `effective_cpm_cents` divides the spend by: every view, from every country, on the clips that can earn. With geo targeting on, this is more than `total_views`.","example":1250000,"isRequired":true,"uniqueKey":"effective_cpm_views","typeLabel":"integer"},"reach":{"oneOf":[{"type":"integer","description":"The unique viewers of each clip, added together. One person who saw two clips counts two times. Null when no clip reported reach.","maximum":9007199254740991,"minimum":-9007199254740991,"example":640000,"isRequired":true,"uniqueKey":"reach.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The unique viewers of each clip, added together. One person who saw two clips counts two times. Null when no clip reported reach.","example":640000,"isRequired":true,"uniqueKey":"reach.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reach","typeLabel":"integer | null"},"reach_clip_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The number of clips that reported reach. Compare it with `clip_count`.","example":41,"isRequired":true,"uniqueKey":"reach_clip_count","typeLabel":"integer"},"reach_clip_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Every view on the clips that reported reach. Use it to compare reach with views.","example":1020000,"isRequired":true,"uniqueKey":"reach_clip_views","typeLabel":"integer"},"clip_count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The number of clips that can earn.","example":48,"isRequired":true,"uniqueKey":"clip_count","typeLabel":"integer"},"likes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Likes on the clips that can earn.","example":61000,"isRequired":true,"uniqueKey":"likes","typeLabel":"integer"},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Comments on the clips that can earn.","example":4300,"isRequired":true,"uniqueKey":"comments","typeLabel":"integer"},"shares":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Shares of the clips that can earn.","example":2700,"isRequired":true,"uniqueKey":"shares","typeLabel":"integer"},"engagements":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Likes, comments and shares added together.","example":68000,"isRequired":true,"uniqueKey":"engagements","typeLabel":"integer"},"engagement_views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Every view, from every country, on the clips that can earn. `engagement_rate` divides by this number.","example":1250000,"isRequired":true,"uniqueKey":"engagement_views","typeLabel":"integer"},"engagement_rate":{"oneOf":[{"description":"`engagements` divided by `engagement_views`, as a fraction to four decimal places. For example, 0.0544 is 5.44%. Null when there are no views yet.","example":0.0544,"type":"number","isRequired":true,"uniqueKey":"engagement_rate.oneOf.0","typeLabel":"number"},{"description":"`engagements` divided by `engagement_views`, as a fraction to four decimal places. For example, 0.0544 is 5.44%. Null when there are no views yet.","example":0.0544,"type":"null","isRequired":true,"uniqueKey":"engagement_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"engagement_rate","typeLabel":"number | null"}},"required":["campaign_id","geo_enabled","total_views","all_views","payable_views","funnel","goal_views","spend_cents","paid_views","free_views","selected_cpm_cents","selected_cpm_is_average","effective_cpm_cents","effective_cpm_views","reach","reach_clip_count","reach_clip_views","clip_count","likes","comments","shares","engagements","engagement_views","engagement_rate"],"additionalProperties":false,"description":"The views, spend and engagement of one campaign. These are the figures on the campaign Analytics tab.","uniqueKey":"","typeLabel":"object"},"example":{"campaign_id":"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60","geo_enabled":false,"total_views":1180000,"all_views":1250000,"payable_views":1100000,"funnel":[{"stage":"total","views":1250000},{"stage":"eligible","views":1180000},{"stage":"priced","views":1180000},{"stage":"capped","views":1100000}],"goal_views":2500000,"spend_cents":220000,"paid_views":1100000,"free_views":80000,"selected_cpm_cents":200,"selected_cpm_is_average":false,"effective_cpm_cents":186,"effective_cpm_views":1180000,"reach":640000,"reach_clip_count":41,"reach_clip_views":1020000,"clip_count":48,"likes":61000,"comments":4300,"shares":2700,"engagements":68000,"engagement_views":1180000,"engagement_rate":0.0576},"examples":{"Example":{"title":"Example","value":{"campaign_id":"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60","geo_enabled":false,"total_views":1180000,"all_views":1250000,"payable_views":1100000,"funnel":[{"stage":"total","views":1250000},{"stage":"eligible","views":1180000},{"stage":"priced","views":1180000},{"stage":"capped","views":1100000}],"goal_views":2500000,"spend_cents":220000,"paid_views":1100000,"free_views":80000,"selected_cpm_cents":200,"selected_cpm_is_average":false,"effective_cpm_cents":186,"effective_cpm_views":1180000,"reach":640000,"reach_clip_count":41,"reach_clip_views":1020000,"clip_count":48,"likes":61000,"comments":4300,"shares":2700,"engagements":68000,"engagement_views":1180000,"engagement_rate":0.0576}}},"exampleType":"examples"}},"exampleType":"examples"},"93fd07e3-121b-47eb-8701-e74e45b106c2":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","title":"Unauthorized error (401)","description":"The error envelope every failed request returns.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"description":"A stable, machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, in words a person can act on.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"The id of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"Unauthorized error (401) · object"},"example":{"error":{"code":"unauthorized","message":"Provide a valid API key as `Authorization: Bearer cb_live_...`.","request_id":"0b7e4d2c-9a1f-4e3b-8c6d-5f2a1b9c7e34"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Provide a valid API key as `Authorization: Bearer cb_live_...`.","request_id":"0b7e4d2c-9a1f-4e3b-8c6d-5f2a1b9c7e34"}}}},"exampleType":"examples"}},"exampleType":"examples"},"dabf3292-a8bc-439c-ad78-782f078aa6df":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","title":"Not found error (404)","description":"The error envelope every failed request returns.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"description":"A stable, machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, in words a person can act on.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"The id of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"Not found error (404) · object"},"example":{"error":{"code":"not_found","message":"No such campaign.","request_id":"3c9a8b7d-2e1f-4a6b-9c8d-7e6f5a4b3c21"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"No such campaign.","request_id":"3c9a8b7d-2e1f-4a6b-9c8d-7e6f5a4b3c21"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d6f85c8f-0669-476d-b028-d35345379bf3":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","title":"Internal server error error (500)","description":"The error envelope every failed request returns.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_error"],"description":"A stable, machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong, in words a person can act on.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"The id of this request. Quote it when you contact support.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message","request_id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"Internal server error error (500) · object"},"example":{"error":{"code":"internal_error","message":"An unexpected error occurred.","request_id":"5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c19"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"An unexpected error occurred.","request_id":"5a4b3c2d-1e0f-4a9b-8c7d-6e5f4a3b2c19"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ee2f83b8-2e1e-4279-ab92-5619ecc13fd8":{"Authorization":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"32291b76-29b0-4420-94cf-a5e5f1ab5194":{"url":"https://app.clipstake.com/api/v1/brand"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"brand-api/openapi.json"},"subdomain":"clipstake-618eb5ee","siteName":"ClipStake Developer Docs","title":"Get campaign metrics - ClipStake Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T11:43:13.939Z","originalFileLocation":"brand-api/api-reference/campaigns/get-campaign-metrics.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=\"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClipStake Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get campaign metrics - ClipStake Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClipStake Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clipstake-618eb5ee.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+campaign+metrics\u0026amp;description=Returns+the+views%2C+spend%2C+CPM+and+engagement+of+one+campaign.+These+are+the+figures+on+the+campaign+Analytics+tab.+A+metric+that+was+not+measured+is+null.\u0026amp;theme=752973628dc7a5916322a68b\u0026amp;signature=72440db67843300b9b5aca54147b3c94ebae57a68e795c260d196e69f1990f4f\">\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 campaign metrics - ClipStake Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clipstake-618eb5ee.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+campaign+metrics\u0026amp;description=Returns+the+views%2C+spend%2C+CPM+and+engagement+of+one+campaign.+These+are+the+figures+on+the+campaign+Analytics+tab.+A+metric+that+was+not+measured+is+null.\u0026amp;theme=752973628dc7a5916322a68b\u0026amp;signature=72440db67843300b9b5aca54147b3c94ebae57a68e795c260d196e69f1990f4f\">\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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClipStake Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#CE1111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/brand-api/api-reference/campaigns/get-campaign-metrics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clipstake.com/#organization\",\"name\":\"ClipStake Developer Docs\",\"url\":\"https://docs.clipstake.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-light.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=7681e523e43fb1457a67bd8fef8635d9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clipstake.com#website\",\"name\":\"ClipStake Developer Docs\",\"url\":\"https://docs.clipstake.com\",\"publisher\":{\"@id\":\"https://docs.clipstake.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics#webpage\",\"url\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics\",\"name\":\"Get campaign metrics\",\"description\":\"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\",\"dateModified\":\"2026-11-04T11:43:13.939Z\",\"isPartOf\":{\"@id\":\"https://docs.clipstake.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.clipstake.com/brand-api/api-reference/brands/list-brands\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/list-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get campaign metrics\",\"item\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics#apireference\",\"headline\":\"Get campaign metrics\",\"name\":\"Get campaign metrics\",\"description\":\"Returns the views, spend, CPM and engagement of one campaign. These are the figures on the campaign Analytics tab. A metric that was not measured is null.\",\"url\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clipstake.com/brand-api/api-reference/campaigns/get-campaign-metrics#webpage\"},\"dateModified\":\"2026-11-04T11:43:13.939Z\",\"publisher\":{\"@id\":\"https://docs.clipstake.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clipstake.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClipStake Developer Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClipStake Developer Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/brand-api/api-reference/campaigns/get-campaign-metrics.md","siteName":"ClipStake Developer Docs","nav":{"global":null,"products":[{"product":"Console API","icon":"terminal","description":"For developers who track media in the console.","pages":[{"title":"Console API","href":"/introduction"}]},{"product":"Agency API","icon":"chart-line","description":"For agencies that read their campaign data and create campaigns.","pages":[{"title":"Agency API","href":"/agency-api/introduction"}]},{"product":"Brand API","icon":"store","description":"For brands that read the data of their campaigns.","groups":[{"group":"Getting Started","pages":[{"title":"Brand API","href":"/brand-api/introduction"},{"title":"Quickstart","href":"/brand-api/quickstart"}]},{"group":"API Reference","pages":[{"group":"Brands","pages":[{"title":"List brands","deprecated":null,"version":null,"sidebarTitle":"List brands","openapi":"/brand-api/openapi.json get /brands","href":"/brand-api/api-reference/brands/list-brands"},{"title":"Get a brand","deprecated":null,"version":null,"sidebarTitle":"Get a brand","openapi":"/brand-api/openapi.json get /brands/{brand_id}","href":"/brand-api/api-reference/brands/get-a-brand"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"sidebarTitle":"List campaigns","openapi":"/brand-api/openapi.json get /campaigns","href":"/brand-api/api-reference/campaigns/list-campaigns"},{"title":"Get a campaign","description":"Returns one campaign. An ID you cannot read gives 404.","deprecated":null,"version":null,"sidebarTitle":"Get a campaign","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}","href":"/brand-api/api-reference/campaigns/get-a-campaign"},{"title":"Get campaign metrics","deprecated":null,"version":null,"sidebarTitle":"Get campaign metrics","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}/metrics","href":"/brand-api/api-reference/campaigns/get-campaign-metrics"},{"title":"Get campaign countries","description":"Returns the views and spend of one campaign for each country, most views first. The country of a view comes from the audience of the account that posted the clip.","deprecated":null,"version":null,"sidebarTitle":"Get campaign countries","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}/countries","href":"/brand-api/api-reference/campaigns/get-campaign-countries"}]},{"group":"Clips","pages":[{"title":"List the clips of a campaign","deprecated":null,"version":null,"sidebarTitle":"List the clips of a campaign","openapi":"/brand-api/openapi.json get /campaigns/{campaign_id}/clips","href":"/brand-api/api-reference/clips/list-the-clips-of-a-campaign"},{"title":"Get a clip","deprecated":null,"version":null,"sidebarTitle":"Get a clip","openapi":"/brand-api/openapi.json get /clips/{clip_id}","href":"/brand-api/api-reference/clips/get-a-clip"}]}]},{"group":"Developer Guides","pages":[{"title":"Authentication","href":"/brand-api/authentication"},{"title":"Pagination","href":"/brand-api/pagination"},{"title":"Errors","href":"/brand-api/errors"}]}]},{"product":"Creator API","icon":"clapperboard","description":"For creators who submit clips from their own tools.","pages":[{"title":"Creator API","href":"/creator-api/introduction"}]}]},"basePath":"","title":"Get campaign metrics - ClipStake Developer Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}