> ## Documentation Index > Fetch the complete documentation index at: https://docs.userecord.io/llms.txt > Use this file to discover all available pages before exploring further. # Get campaign analytics > The same numbers for one campaign: how that batch of candidates went. **Scope:** `analytics:read` ## OpenAPI ````yaml /blue-collar-api/api-reference/openapi.json get /analytics/campaigns/{campaign_id} openapi: 3.1.0 info: title: Record Blue Collar API version: 1.0.0 description: >- Run Record candidate verification from your own system. You need two things: your **key id** and your **secret**. Everything else is generated. See Authentication for how. servers: - url: https://api-bc.userecord.io/api/v1/partner description: Blue Collar API security: [] tags: - name: Skills description: The skill taxonomy, read live a page at a time - name: Skill requests description: Ask Record to add a missing skill - name: Lookups description: >- Lookups for filling in a job mandate: places in India, the countries an abroad job can be in, and the employment types and shifts the playground offers - name: Workflows description: >- Your organisation's blue-collar workflows (read all; change and soft-delete only the ones you created) - name: Job mandates description: >- Your organisation's job mandates, addressed by Record's mandate_id (read all; change only the ones you created) - name: Campaigns description: Contact candidates for one of your jobs and verify them. Spends credits - name: Results description: >- What Record collected from each candidate: status (pending, completed, declined, failed) and an output of answers and verdicts - name: Events description: >- Pull your result events and acknowledge them: the safety net behind the webhook, and a way to receive results without exposing a URL - name: Webhooks description: >- Endpoints that Record POSTs result events to: signed, retried until you acknowledge, replayable - name: Analytics description: >- The workflow Overview analytics of the Record playground: funnel, channels, follow-ups, calls, drop-offs, languages (read-only, scope analytics:read) paths: /analytics/campaigns/{campaign_id}: get: tags: - Analytics summary: Get campaign analytics description: |- The same numbers for one campaign: how that batch of candidates went. **Scope:** `analytics:read` operationId: getCampaignAnalytics parameters: - name: campaign_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9_-]{4,64}$ example: asmnt_9f2c41d7a8b3e65f responses: '200': description: Campaign analytics content: application/json: schema: type: object properties: success: const: true type: boolean message: type: string data: type: object properties: workflow_id: type: string mandate_id: anyOf: - type: string - type: 'null' campaign_id: anyOf: - type: string - type: 'null' analytics: type: object properties: assigned_candidates: type: integer description: Candidates added to the campaigns in scope tracked_candidates: type: integer description: Candidates with a status row in the logs funnel: type: object properties: sent: type: integer description: Invites sent started: type: integer description: Replied interested or started the verification not_started: type: integer description: Sent, but not started completed: type: integer description: Finished the verification and have a verdict verification_methods: type: object properties: total_completed: type: integer video: type: integer audio: type: integer description: Completed over a phone call whatsapp: type: object properties: sent: type: integer delivered: type: integer replied: type: integer failed: type: integer completed: type: integer follow_ups: type: object properties: initial_message: type: integer follow_up_one: type: integer follow_up_two: type: integer follow_up_three: type: integer completed_after_follow_up: type: integer description: >- Candidates who completed after at least one nudge calls: type: object properties: initiated: type: integer completed: type: integer not_answered: type: integer not_interested: type: integer channel_conversions: type: object properties: total_completed: type: integer whatsapp: type: integer description: Completed through the WhatsApp link sms: type: integer description: Completed through the SMS link phone_call: type: integer drop_offs: type: object properties: sent_not_started: type: object properties: count: type: integer percentage: type: number description: In percent description: Sent, never started started_no_verification: type: object properties: count: type: integer percentage: type: number description: In percent description: >- Said interested or asked for a call later, but no verification yet completed_no_verdict: type: object properties: count: type: integer percentage: type: number description: In percent description: Marked completed without a verdict completion_by_language: type: array items: type: object properties: language: type: string reached: type: integer completed: type: integer completion_rate: type: number description: In percent other_interests: type: object properties: completed_candidates: type: integer open_to_other: type: integer description: >- Of those, how many named another role they would take interests: type: array items: type: object properties: name: type: string count: type: integer percentage: type: number experience: type: array items: type: object properties: label: type: string count: type: integer example: success: true data: workflow_id: WF_BG_261009101530123K7M2P9Q4X7R5T8 mandate_id: null campaign_id: asmnt_9f2c41d7a8b3e65f analytics: assigned_candidates: 240 tracked_candidates: 240 funnel: sent: 236 started: 132 not_started: 104 completed: 78 verification_methods: total_completed: 78 video: 60 audio: 18 whatsapp: sent: 236 delivered: 221 replied: 140 failed: 5 completed: 60 follow_ups: initial_message: 236 follow_up_one: 120 follow_up_two: 64 follow_up_three: 0 completed_after_follow_up: 31 calls: initiated: 90 completed: 18 not_answered: 52 not_interested: 9 channel_conversions: total_completed: 78 whatsapp: 52 sms: 8 phone_call: 18 drop_offs: sent_not_started: count: 104 percentage: 44.1 started_no_verification: count: 54 percentage: 40.9 completed_no_verdict: count: 0 percentage: 0 completion_by_language: - language: tamil reached: 150 completed: 51 completion_rate: 34 - language: hindi reached: 70 completed: 22 completion_rate: 31.4 other_interests: completed_candidates: 78 open_to_other: 21 interests: - name: Forklift Operator count: 12 percentage: 57.1 experience: - label: 1 to 2 years count: 9 '404': description: '`NOT_FOUND`: No such campaign.' content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKey: [] SecretKey: [] x-codeSamples: - lang: bash label: cURL source: >- pcall GET "/api/v1/partner/analytics/campaigns/asmnt_9f2c41d7a8b3e65f" - lang: javascript label: JavaScript source: >- const res = await call("GET", "/api/v1/partner/analytics/campaigns/asmnt_9f2c41d7a8b3e65f"); const { data } = await res.json(); - lang: python label: Python source: >- res = call("GET", "/api/v1/partner/analytics/campaigns/asmnt_9f2c41d7a8b3e65f") data = res.json()["data"] components: schemas: Error: type: object properties: success: const: false type: boolean error: type: object properties: code: type: string enum: - VALIDATION_FAILED - LIMIT_EXCEEDED - UNAUTHORIZED - SCOPE_MISSING - FORBIDDEN - HTTPS_REQUIRED - NOT_FOUND - CONFLICT - WORKFLOW_IN_USE - INSUFFICIENT_CREDITS - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_PROGRESS - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - COOLDOWN - DAILY_CAP - SERVICE_DISABLED - SERVER_ERROR message: type: string details: type: array items: type: object properties: path: type: string message: type: string request_id: type: string description: Quote it to Record support securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request. SecretKey: type: apiKey in: header name: x-secret-key description: >- Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.