> ## Documentation Index > Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a campaign funnel > Returns funnel analytics for a campaign — how many contacts are at each stage. The `message` field in the response is `"Funnnel retrieved"` (three n's) — this is a known typo in the response text, not an error. Get funnel analytics for a campaign **A missing record does not return 404.** This handler reports the failure without a status code, and the error envelope defaults to HTTP `200` — you get `200` with `status: "failed"`. Branch on `status`, not on the HTTP code. ## OpenAPI ````yaml /api-reference/specs/campaigns.json get /api/campaigns/funnel/{id} openapi: 3.1.0 info: title: ConveYour API — Campaigns description: >- Retrieve and manage campaigns — the sequences of lessons and triggers delivered to contacts. version: 1.0.0 servers: - url: https://{subdomain}.conveyour.com description: Your organization's ConveYour instance variables: subdomain: default: acme description: >- Your organization's slug — the subdomain you sign in on. Replace `acme` with yours: if you sign in at `bigco.conveyour.com`, enter `bigco`. security: - conveyourToken: [] tags: - name: Campaigns description: >- Retrieve and manage campaigns — the sequences of lessons and triggers delivered to contacts. paths: /api/campaigns/funnel/{id}: get: tags: - Campaigns summary: Get a campaign funnel description: >- Returns funnel analytics for a campaign — how many contacts are at each stage. The `message` field in the response is `"Funnnel retrieved"` (three n's) — this is a known typo in the response text, not an error. Get funnel analytics for a campaign **A missing record does not return 404.** This handler reports the failure without a status code, and the error envelope defaults to HTTP `200` — you get `200` with `status: "failed"`. Branch on `status`, not on the HTTP code. operationId: getFunnelAnalyticsForACampaign parameters: - name: id in: path required: true description: The id identifier. schema: type: string - $ref: '#/components/parameters/teams' responses: '200': description: Success. content: application/json: schema: allOf: - $ref: '#/components/schemas/Envelope' - type: object properties: data: $ref: '#/components/schemas/CampaignFunnel' example: status: ok message: Funnnel retrieved data: campaign_id: 64a1b2c3d4e5f6a7b8c9d0e1 campaign_name: New Hire Onboarding max_applied: 120 funnel: - step: enrolled count: 120 - step: day_1_complete count: 98 - step: completed count: 74 '403': $ref: '#/components/responses/Forbidden' components: parameters: teams: name: teams[] in: query description: >- Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so `teams=A&teams=B` silently resolves to B alone. On requests with a JSON body you may send `teams` (no brackets) in the body instead. **Values that are not valid ObjectIds are silently ignored** — a mistyped team ID behaves as if no team was sent. See the [teams section of the API conventions guide](/guides/api-conventions#team-scoping). style: form explode: true schema: type: array items: type: string example: - 64a1b2c3d4e5f6a7b8c9d0ff schemas: Envelope: type: object description: The common response envelope shared by all ConveYour endpoints. properties: status: type: string enum: - ok - failed description: '`ok` on success, `failed` on error.' message: type: string description: Human-readable description of the result. data: description: >- The response payload — an object or an array depending on the endpoint. CampaignFunnel: type: object description: Funnel report for one campaign. properties: campaign_id: type: string description: The campaign ID. campaign_name: type: string description: The campaign's internal_name, falling back to name. max_applied: type: integer description: Highest contacts_applied across the funnel entries. funnel: type: array items: $ref: '#/components/schemas/FunnelEntry' description: One entry per trigger, in funnel order. required: - campaign_id - campaign_name - max_applied - funnel FunnelEntry: type: object description: One trigger in the funnel. Keys are. properties: id: type: string description: Trigger ID. name: type: string description: Trigger name. parent: type: string description: Parent trigger name. parent_id: type: string description: Parent trigger ID. type: type: string description: Trigger type. paused: type: boolean description: Whether the trigger is paused. contacts_applied: type: integer description: Contacts the trigger applied to. contacts_interacted: type: integer description: Contacts that interacted. responses: Forbidden: description: >- The token is missing or invalid, or the service account behind it lacks the permission this endpoint requires. content: application/json: example: status: failed message: Lacking necessary permission add_contacts data: permission: add_contacts securitySchemes: conveyourToken: type: apiKey in: header name: x-conveyour-token description: >- Your API key token. Contacts endpoints require a **Server-only — Full API** key — see [Authentication](/quickstart). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.