> ## Documentation Index > Fetch the complete documentation index at: https://docs.support.onclarity.com/llms.txt > Use this file to discover all available pages before exploring further. # Get campaign progress > Returns a campaign's progress: contacts per status, calls in progress, completion percentage, retries made, callbacks created, and an activity time series. ## OpenAPI ````yaml /api-reference/voice-openapi.json get /v1/projects/{projectId}/campaigns/{id}/analytics openapi: 3.0.3 info: title: Clarity Voice API version: '1.0' description: Voice agents, outbound calls, conversations, campaigns, and evals. servers: - url: https://voice-api.onclarity.com security: - organizationApiKey: [] tags: - name: Projects description: >- The projects your organization owns. Every other resource lives in a project. - name: Agents description: Create, configure, version and publish voice agents. - name: Outbound calls description: Have a published agent phone a number now. - name: Conversations description: >- One record per call session, with its calls, recordings, transcripts and artifacts. - name: Calls description: The calls of a project, with their status, direction, timing and outcome. - name: Campaigns description: Outbound calling campaigns that phone a list of numbers on a schedule. - name: Eval suites description: >- Reusable sets of eval scenarios and test cases to measure an agent against. - name: Eval judges description: The LLM judges that score eval calls against your test cases. - name: Eval scenarios description: The simulated-caller scenarios of your eval suites. - name: Eval test cases description: The checks a judge applies to each eval call. - name: Eval submissions description: Run an eval suite against an agent and read the verdicts. paths: /v1/projects/{projectId}/campaigns/{id}/analytics: parameters: - $ref: '#/components/parameters/ProjectIdPath' - $ref: '#/components/parameters/CampaignId' get: tags: - Campaigns summary: Get campaign progress description: >- Returns a campaign's progress: contacts per status, calls in progress, completion percentage, retries made, callbacks created, and an activity time series. operationId: getCampaignAnalytics responses: '200': description: The campaign's progress content: application/json: schema: $ref: '#/components/schemas/CampaignAnalyticsResponse' example: analytics: campaign_id: 3f1c2a8e-6b0d-4f6e-9a51-0d2b7c9e4a10 status: running total_items: 200 by_status: draft: 0 scheduled: 118 ongoing: 5 failed: 3 ended: 71 rescheduled: 2 invalid: 1 in_flight_calls: 5 completion: terminal: 77 total: 200 pct: 38.5 retries_made: 4 callbacks_created: 1 timeseries: - ts: '2026-03-02T14:00:00.000Z' ended: 12 failed: 1 rescheduled: 0 total: 13 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: No such campaign in this project. content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: ProjectIdPath: name: projectId in: path required: true schema: type: string description: Project id CampaignId: name: id in: path required: true schema: type: string description: Campaign id schemas: CampaignAnalyticsResponse: type: object required: - analytics properties: analytics: $ref: '#/components/schemas/CampaignAnalytics' Error: type: object required: - error additionalProperties: true properties: error: type: string description: Error message code: type: string description: >- A stable machine-readable reason, present on the refusals a client may branch on. Among them: `PUBLISH_CAPABILITY_REQUIRED` (403, the credential may not change what is live), `AGENT_NOT_PUBLISHED` (409, the agent has no published version yet), `AGENT_TYPE_NOT_DISPATCHABLE` (422, a Voice Assist agent named where an agent must place or take a call; the body carries `agent_type` and `agent_id`), `NOT_APPLICABLE_TO_AGENT_TYPE` (422, a voice-only setting written on a Voice Assist agent), `AGENT_TYPE_BOUNDARY` (409), `AGENT_TYPE_NOT_SUPPORTED` (400), `VOICE_ASSISTANT_REQUIRED` (403, the organization is not licensed for Voice Assist), `ORGANIZATION_UNAVAILABLE` (503) and `REGION_PROFILE_CONFLICT` (503). CampaignAnalytics: type: object required: - campaign_id - status - total_items - by_status - in_flight_calls - completion - retries_made - callbacks_created - timeseries properties: campaign_id: type: string status: type: string enum: - draft - scheduled - running - canceled - ended total_items: type: integer description: Number of contacts on the campaign. by_status: type: object description: Number of contacts per contact status. additionalProperties: type: integer in_flight_calls: type: integer description: Calls in progress right now. completion: type: object required: - terminal - total - pct properties: terminal: type: integer description: >- Contacts that are finished (`ended`, `failed`, `rescheduled` or `invalid`). total: type: integer pct: type: number description: Finished contacts as a percentage of all contacts, one decimal. retries_made: type: integer description: Retry attempts placed so far. callbacks_created: type: integer description: Callback contacts created because a caller asked to be called back. timeseries: type: array description: Contact outcomes over time, one bucket per period with activity. items: type: object required: - ts - ended - failed - rescheduled - total properties: ts: type: string description: Start of the bucket (ISO 8601). ended: type: integer failed: type: integer rescheduled: type: integer total: type: integer responses: Unauthorized: description: No credential was sent, or the API key is invalid or revoked. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid or revoked token Forbidden: description: >- The credential carries no access to this project, or the operation needs administrative rights content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: organizationApiKey: type: http scheme: bearer description: >- Your organization API key (it starts with `anek_org_`). The same key works on the Voice API and the Support API. See [Authentication](/authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.