> ## 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 the overview of an enrichment

> Funnel numbers across all campaigns: uploaded, rejected, sent, delivered, link opened, completed and opted out, and how many candidates stand in each status.

**Scope:** `enrichment:read` or `enrichment:write` or `enrichment:campaigns`



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/overview
openapi: 3.1.0
info:
  title: Record Enrichment API
  version: 1.0.0
  description: >-
    Collect work, location, shift and salary details from your own candidate
    database. 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: Enrichment API
security: []
tags:
  - name: Enrichments
  - name: Enrichment campaigns
  - name: Enrichment candidates
  - name: Enrichment results
  - name: Enrichment credits
paths:
  /enrichments/{enrichment_id}/overview:
    get:
      tags:
        - Enrichments
      summary: Get the overview of an enrichment
      description: >-
        Funnel numbers across all campaigns: uploaded, rejected, sent,
        delivered, link opened, completed and opted out, and how many candidates
        stand in each status.


        **Scope:** `enrichment:read` or `enrichment:write` or
        `enrichment:campaigns`
      operationId: getEnrichmentOverview
      parameters:
        - name: enrichment_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^WF_[A-Z]{2}_[A-Z0-9]{10,40}$
          example: WF_EN_261121094822026AEDRUB86TQVSML
      responses:
        '200':
          description: >-
            Uploaded, sent, delivered, opened, completed and opted out across
            all campaigns
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      enrichment_id:
                        type: string
                      campaign_count:
                        type: integer
                      kpis:
                        type: object
                        properties:
                          uploaded:
                            type: integer
                          rejected:
                            type: integer
                          sent:
                            type: integer
                          delivered:
                            type: integer
                          link_opened:
                            type: integer
                          completed:
                            type: integer
                          opted_out:
                            type: integer
                      standing:
                        type: object
                        additionalProperties:
                          type: integer
                        description: Candidates per status
              example:
                success: true
                data:
                  enrichment_id: WF_EN_261121094822026AEDRUB86TQVSML
                  campaign_count: 1
                  kpis:
                    uploaded: 120
                    rejected: 6
                    sent: 118
                    delivered: 110
                    link_opened: 64
                    completed: 41
                    opted_out: 2
                  standing:
                    completed: 41
                    in_progress: 8
                    sent: 62
                    not_interested: 5
                    opted_out: 2
        '404':
          description: '`NOT_FOUND`: No such enrichment.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            pcall GET
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview")

            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
                - 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.