> ## Documentation Index > Fetch the complete documentation index at: https://docs.brudcast.com/llms.txt > Use this file to discover all available pages before exploring further. # Get campaign recipient metrics > Counts the people a campaign reached rather than the messages it sent: each person is counted once across every channel, which is why these figures differ from the per-channel counters on the campaign statistics endpoint. A figure that could not be measured is returned as null rather than 0, and `coversFullRange` is false when the requested range starts before the event retention window. An unresolvable audience yields nulls rather than an error. Requires the `campaigns:read` scope. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/user/campaigns/{id}/report/recipients openapi: 3.0.0 info: title: Brudcast API version: 1.0.0 servers: - url: https://core-service.prod.brudcast.com description: Production security: [] tags: - name: Analytics x-displayName: Analytics - name: Campaigns x-displayName: Campaigns - name: Contacts x-displayName: Contacts - name: Mailboxes x-displayName: Mailboxes - name: Messages x-displayName: Messages - name: Sender Identities x-displayName: Sender Identities - name: Sending Domains x-displayName: Sending Domains - name: Templates x-displayName: Templates - name: Webhooks x-displayName: Webhooks paths: /api/v1/user/campaigns/{id}/report/recipients: get: tags: - Campaigns summary: Get campaign recipient metrics description: >- Counts the people a campaign reached rather than the messages it sent: each person is counted once across every channel, which is why these figures differ from the per-channel counters on the campaign statistics endpoint. A figure that could not be measured is returned as null rather than 0, and `coversFullRange` is false when the requested range starts before the event retention window. An unresolvable audience yields nulls rather than an error. Requires the `campaigns:read` scope. parameters: - in: header name: X-Organization-Id required: false description: >- Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403. schema: type: string format: uuid - in: query name: from required: false schema: type: string - in: query name: to required: false schema: type: string - in: path name: id required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CampaignRecipientMetricsResponse' '401': description: The credential is missing, malformed, revoked or expired content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The key lacks the scope the endpoint requires, or the organization does not match the credential content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: The payload or query string failed validation content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '429': description: >- Rate limit exceeded; retry after the number of seconds in `retryAfter` content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' security: - apiKey: [] - apiKeyBearer: [] components: schemas: CampaignRecipientMetricsResponse: type: object properties: success: type: boolean example: true message: type: string data: $ref: '#/components/schemas/CampaignRecipientMetrics' required: - success - message - data ErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Resource not found code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_ROW_NOT_FOUND required: - success - message - code ValidationErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: The payload is invalid code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_VALIDATION_ERROR errors: type: array items: $ref: '#/components/schemas/ValidationErrorItem' required: - success - message - code - errors RateLimitErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Too many requests code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_TOO_MANY_REQUESTS retryAfter: type: number example: 60 required: - success - message - code - retryAfter CampaignRecipientMetrics: type: object properties: scope: type: string enum: - cross_channel - per_channel audienceSize: type: number nullable: true description: Audience frozen at dispatch, null when it was never measured audienceIsAggregated: type: boolean description: >- True when the audience is summed over several campaigns and so double counts a contact addressed by more than one of them. Reach and engagement are always deduplicated, so the two must not be divided against each other when this is set reached: type: number nullable: true description: >- People who received at least one message, counted once, null when not measured engaged: type: number nullable: true description: People who opened or clicked, counted once, null when not measured clicked: type: number nullable: true description: People who clicked, counted once, null when not measured retentionDays: type: number description: How many days of per-recipient events are retained coversFullRange: type: boolean description: False when the requested range starts before the retention window required: - scope - audienceSize - audienceIsAggregated - reached - engaged - clicked - retentionDays - coversFullRange ValidationErrorItem: type: object properties: field: type: string example: emailAddress rule: type: string example: email message: type: string example: The emailAddress field must be a valid email address required: - field - rule - message securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: >- An organization API key, prefixed `bk_live_`. Takes precedence over `Authorization` when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint. apiKeyBearer: type: http scheme: bearer bearerFormat: bk_live_... description: >- The same organization API key sent as `Authorization: Bearer bk_live_...`. Accepted only when the value begins with `bk_` and no `X-API-Key` header is present. ````