Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates.
Scope & API Key Requirements
Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user.
Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email.
If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden.
Pagination & Rollup Behavior
summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters.
limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.
Reporting scope. Defaults to user (requires a personal User API key). Set to org to aggregate across all team members in the organization (requires an Organization API key).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Precept API","colors":{"primary":"#1D4ED8","light":"#3B82F6","dark":"#1E3A8A"},"logo":{"light":"https://mintcdn.com/precept/ZNWTJJJ682eOlJcx/logo/precept-full.png?fit=max\u0026auto=format\u0026n=ZNWTJJJ682eOlJcx\u0026q=85\u0026s=29574bc08725b5377625ac95b83faed6","dark":"https://mintcdn.com/precept/ZNWTJJJ682eOlJcx/logo/precept-full.png?fit=max\u0026auto=format\u0026n=ZNWTJJJ682eOlJcx\u0026q=85\u0026s=29574bc08725b5377625ac95b83faed6"},"favicon":"https://mintcdn.com/precept/ZNWTJJJ682eOlJcx/logo/precept-full.png?fit=max\u0026auto=format\u0026n=ZNWTJJJ682eOlJcx\u0026q=85\u0026s=29574bc08725b5377625ac95b83faed6","navbar":{"primary":{"type":"button","label":"Precept","href":"https://app.preceptai.co.uk/developer"}},"footer":{"socials":{"website":"https://www.preceptai.co.uk"}},"seo":{},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"precept","hasAudioNarration":false,"actualSubdomain":"precept","customDomains":["docs.preceptai.co.uk"],"gitSource":{"type":"github","owner":"johnbabat","repo":"precept-api-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af1cf8c66d9dbd001dadf9f","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":10},{"language":"default","tag":"API Endpoints","count":8},{"language":"default","tag":"Essentials","count":3},{"language":"default","tag":"People","count":3},{"language":"default","tag":"Webhook Examples","count":2},{"language":"default","tag":"Getting Started","count":2},{"language":"default","tag":"Integrations","count":2},{"language":"default","tag":"Companies","count":2},{"language":"default","tag":"Billing","count":1},{"language":"default","tag":"Campaigns","count":1}]},"assistantConfig":{},"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":"api-reference/campaigns/get-campaign-metrics","slug":"/api-reference/campaigns/get-campaign-metrics","pageMetadata":{"title":"Get Campaign Metrics","description":"\n\nRetrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates.\n\n### Scope \u0026 API Key Requirements\n- **Personal / User Scope (`GET /v1/campaigns`)**: Requires a **User API key**. Returns campaigns and aggregated performance metrics for that user.\n- **Organization Scope (`GET /v1/campaigns?scope=org`)**: Requires an **Organization Service API key**. Aggregates campaigns across all seats in the organization, includes a `byUser` performance breakdown, and attributes each campaign by team member name and email.\n\nIf a User API key is used with `?scope=org`, or an Organization API key is used without `?scope=org`, the endpoint returns `403 Forbidden`.\n\n### Pagination \u0026 Rollup Behavior\n- **`summary` and `byUser` are never truncated by `limit`**: They always compute the complete totals across **all** campaigns and team members matching your `status` and `startDate`/`endDate` filters.\n- **`limit` and `offset` paginate the `campaigns` array**: When `scope=org`, campaigns from all team members are merged into a single chronological list sorted newest-first (`createdAt` descending), and `limit` controls how many campaign items are returned per page.","deprecated":null,"version":null,"openapi":"/api-reference/combined.json get /v1/campaigns","href":"/api-reference/campaigns/get-campaign-metrics","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates.\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Scope \u0026 API Key Requirements\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [\"Personal / User Scope (\", _jsx(_components.code, {\n children: \"GET /v1/campaigns\"\n }), \")\"]\n }), \": Requires a \", _jsx(_components.strong, {\n children: \"User API key\"\n }), \". Returns campaigns and aggregated performance metrics for that user.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [\"Organization Scope (\", _jsx(_components.code, {\n children: \"GET /v1/campaigns?scope=org\"\n }), \")\"]\n }), \": Requires an \", _jsx(_components.strong, {\n children: \"Organization Service API key\"\n }), \". Aggregates campaigns across all seats in the organization, includes a \", _jsx(_components.code, {\n children: \"byUser\"\n }), \" performance breakdown, and attributes each campaign by team member name and email.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If a User API key is used with \", _jsx(_components.code, {\n children: \"?scope=org\"\n }), \", or an Organization API key is used without \", _jsx(_components.code, {\n children: \"?scope=org\"\n }), \", the endpoint returns \", _jsx(_components.code, {\n children: \"403 Forbidden\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Pagination \u0026 Rollup Behavior\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"summary\"\n }), \" and \", _jsx(_components.code, {\n children: \"byUser\"\n }), \" are never truncated by \", _jsx(_components.code, {\n children: \"limit\"\n })]\n }), \": They always compute the complete totals across \", _jsx(_components.strong, {\n children: \"all\"\n }), \" campaigns and team members matching your \", _jsx(_components.code, {\n children: \"status\"\n }), \" and \", _jsx(_components.code, {\n children: \"startDate\"\n }), \"/\", _jsx(_components.code, {\n children: \"endDate\"\n }), \" filters.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"limit\"\n }), \" and \", _jsx(_components.code, {\n children: \"offset\"\n }), \" paginate the \", _jsx(_components.code, {\n children: \"campaigns\"\n }), \" array\"]\n }), \": When \", _jsx(_components.code, {\n children: \"scope=org\"\n }), \", campaigns from all team members are merged into a single chronological list sorted newest-first (\", _jsx(_components.code, {\n children: \"createdAt\"\n }), \" descending), and \", _jsx(_components.code, {\n children: \"limit\"\n }), \" controls how many campaign items are returned per page.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Campaign Metrics","description":"\n\nRetrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates.\n\n### Scope \u0026 API Key Requirements\n- **Personal / User Scope (`GET /v1/campaigns`)**: Requires a **User API key**. Returns campaigns and aggregated performance metrics for that user.\n- **Organization Scope (`GET /v1/campaigns?scope=org`)**: Requires an **Organization Service API key**. Aggregates campaigns across all seats in the organization, includes a `byUser` performance breakdown, and attributes each campaign by team member name and email.\n\nIf a User API key is used with `?scope=org`, or an Organization API key is used without `?scope=org`, the endpoint returns `403 Forbidden`.\n\n### Pagination \u0026 Rollup Behavior\n- **`summary` and `byUser` are never truncated by `limit`**: They always compute the complete totals across **all** campaigns and team members matching your `status` and `startDate`/`endDate` filters.\n- **`limit` and `offset` paginate the `campaigns` array**: When `scope=org`, campaigns from all team members are merged into a single chronological list sorted newest-first (`createdAt` descending), and `limit` controls how many campaign items are returned per page.","deprecated":null,"version":null,"openapi":"/api-reference/combined.json get /v1/campaigns","href":"/api-reference/campaigns/get-campaign-metrics","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Campaign Metrics","description":"\n\nRetrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates.\n\n### Scope \u0026 API Key Requirements\n- **Personal / User Scope (`GET /v1/campaigns`)**: Requires a **User API key**. Returns campaigns and aggregated performance metrics for that user.\n- **Organization Scope (`GET /v1/campaigns?scope=org`)**: Requires an **Organization Service API key**. Aggregates campaigns across all seats in the organization, includes a `byUser` performance breakdown, and attributes each campaign by team member name and email.\n\nIf a User API key is used with `?scope=org`, or an Organization API key is used without `?scope=org`, the endpoint returns `403 Forbidden`.\n\n### Pagination \u0026 Rollup Behavior\n- **`summary` and `byUser` are never truncated by `limit`**: They always compute the complete totals across **all** campaigns and team members matching your `status` and `startDate`/`endDate` filters.\n- **`limit` and `offset` paginate the `campaigns` array**: When `scope=org`, campaigns from all team members are merged into a single chronological list sorted newest-first (`createdAt` descending), and `limit` controls how many campaign items are returned per page.","tags":["Campaigns"],"parameters":["31603741-7c8f-43ab-a266-ea76525ea973","669b54a6-9b8c-49a2-bf2d-90dc767f2658","7a8dffa9-7899-4e7e-a81b-2a33801debe0","81afb241-46d2-42aa-8167-29fc904ed688","274a4f8e-6032-488b-ae8c-3b653d807d07","c64433a8-c664-4675-bf28-1f105cec82f7"],"responses":{"200":"68d31b35-a3cc-4b32-b9f9-77b974a0a408","400":"7176242d-5ab9-4945-9628-79dace6923f7","401":"4fb6ba21-3976-4a73-a020-ebacbf3f54d8","403":"98ae7d9c-052c-4c5c-827f-6a71327b6822","500":"3b7c6450-a5e7-412b-8926-dc9bf5709693"},"method":"get","type":"path","servers":["5c46836d-994d-4d0f-9a23-94f8b0ca7e1a"],"security":["dea0ffa9-b304-48ef-862a-c10443272d7a"],"path":"/v1/campaigns","baseUrlOptions":["https://api.preceptai.co.uk"],"title":"Get Campaign Metrics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"31603741-7c8f-43ab-a266-ea76525ea973":{"name":"scope","in":"query","required":false,"description":"Reporting scope. Defaults to `user` (requires a personal User API key). Set to `org` to aggregate across all team members in the organization (requires an Organization API key).","schema":{"type":"string","enum":["user","org"],"default":"user","isRequired":false,"description":"Reporting scope. Defaults to `user` (requires a personal User API key). Set to `org` to aggregate across all team members in the organization (requires an Organization API key).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"669b54a6-9b8c-49a2-bf2d-90dc767f2658":{"name":"status","in":"query","required":false,"description":"Filter campaigns by status (`all`, `running`, `paused`, `queued`, `completed`, `stopped`, `archived`). Supports comma-separated values (e.g. `running,completed`).","schema":{"type":"string","default":"all","isRequired":false,"description":"Filter campaigns by status (`all`, `running`, `paused`, `queued`, `completed`, `stopped`, `archived`). Supports comma-separated values (e.g. `running,completed`).","uniqueKey":"","typeLabel":"string"}},"7a8dffa9-7899-4e7e-a81b-2a33801debe0":{"name":"startDate","in":"query","required":false,"description":"Filter campaigns created on or after this date (ISO 8601 timestamp or `YYYY-MM-DD`).","schema":{"type":"string","example":"2026-10-01","isRequired":false,"description":"Filter campaigns created on or after this date (ISO 8601 timestamp or `YYYY-MM-DD`).","uniqueKey":"","typeLabel":"string"}},"81afb241-46d2-42aa-8167-29fc904ed688":{"name":"endDate","in":"query","required":false,"description":"Filter campaigns created on or before this date (ISO 8601 timestamp or `YYYY-MM-DD`).","schema":{"type":"string","example":"2026-11-09","isRequired":false,"description":"Filter campaigns created on or before this date (ISO 8601 timestamp or `YYYY-MM-DD`).","uniqueKey":"","typeLabel":"string"}},"274a4f8e-6032-488b-ae8c-3b653d807d07":{"name":"limit","in":"query","required":false,"description":"Number of campaign items to return per page in the `campaigns` array (1 to 100, sorted newest-first). Does not limit `summary` or `byUser` totals.","schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"isRequired":false,"description":"Number of campaign items to return per page in the `campaigns` array (1 to 100, sorted newest-first). Does not limit `summary` or `byUser` totals.","uniqueKey":"","typeLabel":"integer"}},"c64433a8-c664-4675-bf28-1f105cec82f7":{"name":"offset","in":"query","required":false,"description":"Pagination offset for the `campaigns` array (0 or greater).","schema":{"type":"integer","minimum":0,"default":0,"isRequired":false,"description":"Pagination offset for the `campaigns` array (0 or greater).","uniqueKey":"","typeLabel":"integer"}}},"responses":{"68d31b35-a3cc-4b32-b9f9-77b974a0a408":{"description":"Campaign list, aggregate summary metrics, and conversion rates.","content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","enum":["user","organization"],"description":"The resolved reporting scope.","uniqueKey":"scope","typeLabel":"enum\u003cstring>"},"timeframe":{"type":"object","properties":{"startDate":{"oneOf":[{"type":"string","description":"Resolved ISO start date filter, or null for all-time.","uniqueKey":"timeframe.startDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved ISO start date filter, or null for all-time.","uniqueKey":"timeframe.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"timeframe.startDate","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"Resolved ISO end date filter, or null for all-time.","uniqueKey":"timeframe.endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Resolved ISO end date filter, or null for all-time.","uniqueKey":"timeframe.endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"timeframe.endDate","typeLabel":"string | null"}},"uniqueKey":"timeframe","typeLabel":"object"},"summary":{"type":"object","properties":{"totalCampaigns":{"type":"integer","description":"Total number of campaigns matching the filter.","uniqueKey":"summary.totalCampaigns","typeLabel":"integer"},"activeUsers":{"type":"integer","description":"Number of team members with campaigns in the filtered period (only present when scope is `organization`).","uniqueKey":"summary.activeUsers","typeLabel":"integer"},"totalLeads":{"type":"integer","description":"Total leads targeted across all matching campaigns.","uniqueKey":"summary.totalLeads","typeLabel":"integer"},"totalInvited":{"type":"integer","description":"Total connection requests sent.","uniqueKey":"summary.totalInvited","typeLabel":"integer"},"totalAccepted":{"type":"integer","description":"Total connection requests accepted.","uniqueKey":"summary.totalAccepted","typeLabel":"integer"},"overallAcceptanceRate":{"type":"number","description":"Overall acceptance rate percentage (0 to 100).","uniqueKey":"summary.overallAcceptanceRate","typeLabel":"number"},"totalMessagesSent":{"type":"integer","description":"Total follow-up messages sent.","uniqueKey":"summary.totalMessagesSent","typeLabel":"integer"},"totalReplies":{"type":"integer","description":"Total replies received.","uniqueKey":"summary.totalReplies","typeLabel":"integer"},"overallReplyRate":{"type":"number","description":"Overall reply rate percentage (0 to 100).","uniqueKey":"summary.overallReplyRate","typeLabel":"number"}},"uniqueKey":"summary","typeLabel":"object"},"byUser":{"type":"array","description":"Per-seat campaign performance breakdown (only included when `scope=org`).","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"byUser.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"byUser.items.[INDEX].email","typeLabel":"string"},"campaignCount":{"type":"integer","uniqueKey":"byUser.items.[INDEX].campaignCount","typeLabel":"integer"},"totalLeads":{"type":"integer","uniqueKey":"byUser.items.[INDEX].totalLeads","typeLabel":"integer"},"invitedCount":{"type":"integer","uniqueKey":"byUser.items.[INDEX].invitedCount","typeLabel":"integer"},"acceptedCount":{"type":"integer","uniqueKey":"byUser.items.[INDEX].acceptedCount","typeLabel":"integer"},"acceptanceRate":{"type":"number","uniqueKey":"byUser.items.[INDEX].acceptanceRate","typeLabel":"number"},"messagesSentCount":{"type":"integer","uniqueKey":"byUser.items.[INDEX].messagesSentCount","typeLabel":"integer"},"repliedCount":{"type":"integer","uniqueKey":"byUser.items.[INDEX].repliedCount","typeLabel":"integer"},"replyRate":{"type":"number","uniqueKey":"byUser.items.[INDEX].replyRate","typeLabel":"number"}},"uniqueKey":"byUser.items.[INDEX]","typeLabel":"object"},"uniqueKey":"byUser","typeLabel":"object[]"},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"campaigns.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"campaigns.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["running","paused","queued","completed","stopped","archived"],"uniqueKey":"campaigns.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"userName":{"type":"string","description":"Team member name (included when `scope=org`).","uniqueKey":"campaigns.items.[INDEX].userName","typeLabel":"string"},"userEmail":{"type":"string","description":"Team member email (included when `scope=org`).","uniqueKey":"campaigns.items.[INDEX].userEmail","typeLabel":"string"},"currentIndex":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].currentIndex","typeLabel":"integer"},"totalLeads":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].totalLeads","typeLabel":"integer"},"progressPct":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].progressPct","typeLabel":"integer"},"invitedCount":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].invitedCount","typeLabel":"integer"},"acceptedCount":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].acceptedCount","typeLabel":"integer"},"acceptanceRate":{"type":"number","description":"Percentage of invited leads who accepted the connection request.","uniqueKey":"campaigns.items.[INDEX].acceptanceRate","typeLabel":"number"},"messageSentCount":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].messageSentCount","typeLabel":"integer"},"repliedCount":{"type":"integer","uniqueKey":"campaigns.items.[INDEX].repliedCount","typeLabel":"integer"},"replyRate":{"type":"number","description":"Percentage of messaged leads who replied.","uniqueKey":"campaigns.items.[INDEX].replyRate","typeLabel":"number"},"createdAt":{"oneOf":[{"type":"string","uniqueKey":"campaigns.items.[INDEX].createdAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaigns.items.[INDEX].createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaigns.items.[INDEX].createdAt","typeLabel":"string | null"},"updatedAt":{"oneOf":[{"type":"string","uniqueKey":"campaigns.items.[INDEX].updatedAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaigns.items.[INDEX].updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaigns.items.[INDEX].updatedAt","typeLabel":"string | null"},"finishedAt":{"oneOf":[{"type":"integer","uniqueKey":"campaigns.items.[INDEX].finishedAt.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"campaigns.items.[INDEX].finishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaigns.items.[INDEX].finishedAt","typeLabel":"integer | null"}},"uniqueKey":"campaigns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaigns","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"total":{"type":"integer","uniqueKey":"pagination.total","typeLabel":"integer"},"limit":{"type":"integer","uniqueKey":"pagination.limit","typeLabel":"integer"},"offset":{"type":"integer","uniqueKey":"pagination.offset","typeLabel":"integer"},"hasMore":{"type":"boolean","uniqueKey":"pagination.hasMore","typeLabel":"boolean"}},"uniqueKey":"pagination","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"user_scope":{"title":"user_scope","value":{"scope":"user","timeframe":{"startDate":"2026-10-01T00:00:00.000Z","endDate":"2026-11-09T23:59:59.999Z"},"summary":{"totalCampaigns":8,"totalLeads":400,"totalInvited":350,"totalAccepted":112,"overallAcceptanceRate":32,"totalMessagesSent":100,"totalReplies":22,"overallReplyRate":22},"campaigns":[{"id":"camp_abc123","name":"Fintech Decision Makers Q4","status":"completed","currentIndex":50,"totalLeads":50,"progressPct":100,"invitedCount":50,"acceptedCount":18,"acceptanceRate":36,"messageSentCount":18,"repliedCount":5,"replyRate":27.8,"createdAt":"2026-11-02T14:30:00.000Z","updatedAt":"2026-11-04T18:00:00.000Z","finishedAt":1793740200000}],"pagination":{"total":8,"limit":25,"offset":0,"hasMore":false}}},"organization_scope":{"title":"organization_scope","value":{"scope":"organization","timeframe":{"startDate":"2026-10-01T00:00:00.000Z","endDate":"2026-11-09T23:59:59.999Z"},"summary":{"totalCampaigns":14,"activeUsers":2,"totalLeads":700,"totalInvited":580,"totalAccepted":174,"overallAcceptanceRate":30,"totalMessagesSent":160,"totalReplies":32,"overallReplyRate":20},"byUser":[{"name":"Alex Morgan","email":"alex@acme.com","campaignCount":8,"totalLeads":400,"invitedCount":350,"acceptedCount":112,"acceptanceRate":32,"messagesSentCount":100,"repliedCount":22,"replyRate":22},{"name":"Sarah Jenkins","email":"sarah@acme.com","campaignCount":6,"totalLeads":300,"invitedCount":230,"acceptedCount":62,"acceptanceRate":27,"messagesSentCount":60,"repliedCount":10,"replyRate":16.7}],"campaigns":[{"id":"camp_9921","name":"Fintech Decision Makers Q4","status":"completed","userName":"Alex Morgan","userEmail":"alex@acme.com","currentIndex":50,"totalLeads":50,"progressPct":100,"invitedCount":50,"acceptedCount":18,"acceptanceRate":36,"messageSentCount":18,"repliedCount":5,"replyRate":27.8,"createdAt":"2026-11-02T14:30:00.000Z","updatedAt":"2026-11-04T18:00:00.000Z","finishedAt":1793740200000},{"id":"camp_8840","name":"Enterprise VP Sales UK","status":"running","userName":"Sarah Jenkins","userEmail":"sarah@acme.com","currentIndex":20,"totalLeads":50,"progressPct":40,"invitedCount":20,"acceptedCount":7,"acceptanceRate":35,"messageSentCount":5,"repliedCount":1,"replyRate":20,"createdAt":"2026-11-01T09:15:00.000Z","updatedAt":"2026-11-09T12:00:00.000Z","finishedAt":null}],"pagination":{"total":14,"limit":25,"offset":0,"hasMore":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"7176242d-5ab9-4945-9628-79dace6923f7":{"description":"Invalid query parameter (`scope`, `status`, `startDate`, `endDate`, `limit`, or `offset`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4fb6ba21-3976-4a73-a020-ebacbf3f54d8":{"description":"Unauthorized: Missing or invalid authorization header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"98ae7d9c-052c-4c5c-827f-6a71327b6822":{"description":"Forbidden: Invalid API key, or API key type does not match the requested `scope`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"user_key_on_org_scope":{"title":"user_key_on_org_scope","value":{"error":"Forbidden: An organization API key is required to access organization-level campaigns. Your API key type is 'user'."}},"org_key_on_user_scope":{"title":"org_key_on_user_scope","value":{"error":"Forbidden: An organization API key cannot query personal user scope. Please provide a user API key, or add '?scope=org' to access organization campaigns."}}},"exampleType":"examples"}},"exampleType":"examples"},"3b7c6450-a5e7-412b-8926-dc9bf5709693":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dea0ffa9-b304-48ef-862a-c10443272d7a":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"5c46836d-994d-4d0f-9a23-94f8b0ca7e1a":{"url":"https://api.preceptai.co.uk"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/combined.json"},"subdomain":"precept","siteName":"Precept API","title":"Get Campaign Metrics - Precept API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T13:50:10.409Z","originalFileLocation":"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=\"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates. ### Scope \u0026amp; API Key Requirements - Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user. - Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email. If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden. ### Pagination \u0026amp; Rollup Behavior - summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters. - limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Precept API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_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/precept/qg3p4hZBAKHbEGg6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Campaign Metrics - Precept API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates. ### Scope \u0026amp; API Key Requirements - Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user. - Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email. If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden. ### Pagination \u0026amp; Rollup Behavior - summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters. - limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Precept API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://precept.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+Campaign+Metrics\u0026amp;description=%0A%0ARetrieve+your+LinkedIn+outreach+campaigns+along+with+volume+metrics%2C+funnel+counts%2C+and+acceptance%2Freply+conversion+rates.%0A%0A%23%23%23+Scope+%26+API+Key+Requirements%0A-\u0026amp;theme=d44622a2516bea18105ae64f\u0026amp;signature=108974306f3bc9fc887bc931dc19ce3b71127b66e72b6ed3eb603d2d97432575\">\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 - Precept API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates. ### Scope \u0026amp; API Key Requirements - Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user. - Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email. If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden. ### Pagination \u0026amp; Rollup Behavior - summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters. - limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://precept.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+Campaign+Metrics\u0026amp;description=%0A%0ARetrieve+your+LinkedIn+outreach+campaigns+along+with+volume+metrics%2C+funnel+counts%2C+and+acceptance%2Freply+conversion+rates.%0A%0A%23%23%23+Scope+%26+API+Key+Requirements%0A-\u0026amp;theme=d44622a2516bea18105ae64f\u0026amp;signature=108974306f3bc9fc887bc931dc19ce3b71127b66e72b6ed3eb603d2d97432575\">\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/precept/qg3p4hZBAKHbEGg6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Precept API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1D4ED8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.preceptai.co.uk/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=\"/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.preceptai.co.uk/#organization\",\"name\":\"Precept API\",\"url\":\"https://docs.preceptai.co.uk\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/precept/ZNWTJJJ682eOlJcx/logo/precept-full.png?fit=max\u0026auto=format\u0026n=ZNWTJJJ682eOlJcx\u0026q=85\u0026s=29574bc08725b5377625ac95b83faed6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.preceptai.co.uk#website\",\"name\":\"Precept API\",\"url\":\"https://docs.preceptai.co.uk\",\"publisher\":{\"@id\":\"https://docs.preceptai.co.uk/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics#webpage\",\"url\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics\",\"name\":\"Get Campaign Metrics\",\"description\":\"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates. ### Scope \u0026 API Key Requirements - Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user. - Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email. If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden. ### Pagination \u0026 Rollup Behavior - summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters. - limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.\",\"dateModified\":\"2026-11-09T13:50:10.409Z\",\"isPartOf\":{\"@id\":\"https://docs.preceptai.co.uk#website\"},\"breadcrumb\":{\"@id\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.preceptai.co.uk/api-reference/companies/get-company-insights\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Endpoints\",\"item\":\"https://docs.preceptai.co.uk/api-reference/companies/get-company-insights\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Campaign Metrics\",\"item\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics#apireference\",\"headline\":\"Get Campaign Metrics\",\"name\":\"Get Campaign Metrics\",\"description\":\"Retrieve your LinkedIn outreach campaigns along with volume metrics, funnel counts, and acceptance/reply conversion rates. ### Scope \u0026 API Key Requirements - Personal / User Scope (GET /v1/campaigns): Requires a User API key. Returns campaigns and aggregated performance metrics for that user. - Organization Scope (GET /v1/campaigns?scope=org): Requires an Organization Service API key. Aggregates campaigns across all seats in the organization, includes a byUser performance breakdown, and attributes each campaign by team member name and email. If a User API key is used with ?scope=org, or an Organization API key is used without ?scope=org, the endpoint returns 403 Forbidden. ### Pagination \u0026 Rollup Behavior - summary and byUser are never truncated by limit: They always compute the complete totals across all campaigns and team members matching your status and startDate/endDate filters. - limit and offset paginate the campaigns array: When scope=org, campaigns from all team members are merged into a single chronological list sorted newest-first (createdAt descending), and limit controls how many campaign items are returned per page.\",\"url\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.preceptai.co.uk/api-reference/campaigns/get-campaign-metrics#webpage\"},\"dateModified\":\"2026-11-09T13:50:10.409Z\",\"publisher\":{\"@id\":\"https://docs.preceptai.co.uk/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.preceptai.co.uk#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Precept API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Precept API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/campaigns/get-campaign-metrics.md","siteName":"Precept API","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"house","href":"/introduction"},{"title":"Authentication","icon":"key","href":"/authentication"}]},{"group":"Essentials","pages":[{"title":"Understanding Credits","icon":"coins","href":"/essentials/credits"},{"title":"Rate Limits, Speed, and Volume","icon":"gauge-high","href":"/essentials/rate-limits"},{"title":"Company Enrichments","icon":"chart-mixed","href":"/essentials/enrichments"}]},{"group":"Integrations","pages":[{"title":"Make","icon":"plug","href":"/integrations/make"},{"title":"n8n","icon":"plug","href":"/integrations/n8n"}]},{"group":"API Reference","pages":[{"group":"API Endpoints","pages":[{"group":"Companies","pages":[{"title":"Get Company Insights","deprecated":null,"version":null,"openapi":"/api-reference/combined.json post /v1/companies/insights","href":"/api-reference/companies/get-company-insights"},{"title":"Search Companies via Query","deprecated":null,"version":null,"openapi":"/api-reference/combined.json post /v1/companies/search","href":"/api-reference/companies/search-companies-via-query"}]},{"group":"People","pages":[{"title":"Start Contacts Enrichment","deprecated":null,"version":null,"openapi":"/api-reference/combined.json post /v1/leads/enrich","href":"/api-reference/people/start-contacts-enrichment"},{"title":"Search People via Query","deprecated":null,"version":null,"openapi":"/api-reference/combined.json post /v1/leads/search","href":"/api-reference/people/search-people-via-query"},{"title":"Discover People from LinkedIn Posts","deprecated":null,"version":null,"openapi":"/api-reference/combined.json post /v1/leads/post-search","href":"/api-reference/people/discover-people-from-linkedin-posts"}]},{"group":"Jobs","pages":[{"title":"Get Job Status","deprecated":null,"version":null,"openapi":"/api-reference/combined.json get /v1/jobs/{jobId}","href":"/api-reference/jobs/get-job-status"}]},{"group":"Billing","pages":[{"title":"Get Remaining Credits","description":"\n\nRetrieve the remaining credit balance for the authenticated user/organization.\n\nUse this endpoint to monitor your usage and programmatically check how many credits are available for search and enrichment requests.","deprecated":null,"version":null,"openapi":"/api-reference/combined.json get /v1/credits","href":"/api-reference/billing/get-remaining-credits"}]},{"group":"Campaigns","pages":[{"title":"Get Campaign Metrics","deprecated":null,"version":null,"openapi":"/api-reference/combined.json get /v1/campaigns","href":"/api-reference/campaigns/get-campaign-metrics"}]}]},{"group":"Webhook Examples","pages":[{"title":"Company Webhooks","openapi":"combined.json webhook companyInsightsWebhook","description":null,"href":"/api-reference/webhooks/companies-webhooks"},{"title":"People Webhooks","openapi":"combined.json webhook leadEnrichmentWebhook","href":"/api-reference/webhooks/leads-webhooks"}]}]}]},"basePath":"","title":"Get Campaign Metrics - Precept API","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}