> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vambe.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Get campaign

> Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.



## OpenAPI

````yaml get /api/public/outreach-campaign/{campaignId}
openapi: 3.0.0
info:
  title: Vambe AI API
  description: Vambe AI documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.vambe.me
    description: Production Server
security: []
tags:
  - name: Vambe AI
    description: ''
paths:
  /api/public/outreach-campaign/{campaignId}:
    get:
      tags:
        - Campaigns
      summary: Get campaign
      description: >-
        Retrieve one campaign with its results (reach, responses, conversions
        and revenue) and the performance of each send step. Use Get campaign
        recipients for the per-recipient detail.
      operationId: PublicCampaignController_getCampaign
      parameters:
        - name: x-api-key
          in: header
          description: API key needed to authorize the request
          required: true
          schema:
            type: string
        - name: campaignId
          required: true
          in: path
          description: The ID of the campaign, from List campaigns
          schema:
            format: uuid
            type: string
      responses:
        '200':
          description: Campaign retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    format: uuid
                    type: string
                  name:
                    type: string
                    example: Autocash Septiembre
                  status:
                    type: string
                    enum:
                      - draft
                      - active
                      - paused
                      - archived
                  campaign_type:
                    type: string
                    enum:
                      - one_time
                  kpi_event:
                    type: object
                    nullable: true
                    description: The conversion goal of the campaign
                    properties:
                      key:
                        type: string
                        example: order_created
                      stage_id:
                        type: string
                        format: uuid
                        nullable: true
                  audience:
                    type: object
                    properties:
                      status:
                        type: string
                      source:
                        type: string
                        nullable: true
                      segment:
                        type: object
                        nullable: true
                        properties:
                          id:
                            format: uuid
                            type: string
                          name:
                            type: string
                      size:
                        type: integer
                        description: Number of recipients
                  lifecycle:
                    type: string
                    enum:
                      - notSent
                      - inProcess
                      - finished
                  delivery:
                    type: object
                    properties:
                      not_started:
                        type: integer
                      running:
                        type: integer
                      finished:
                        type: integer
                      last_batch_at:
                        type: string
                        format: date-time
                        nullable: true
                  created_at:
                    format: date-time
                    type: string
                  front_url:
                    type: string
                    description: Link to the campaign in Vambe
                  first_batch_at:
                    type: string
                    format: date-time
                    nullable: true
                  results:
                    type: object
                    properties:
                      audience:
                        type: integer
                        description: Number of recipients
                      dispatched:
                        type: integer
                      reached:
                        type: integer
                        description: Recipients at least one step reached
                      failed:
                        type: integer
                      system_errors:
                        type: integer
                      reach_breakdown:
                        type: object
                        properties:
                          full:
                            type: integer
                          partial:
                            type: integer
                          none:
                            type: integer
                          stopped:
                            type: integer
                      responded:
                        type: object
                        properties:
                          count:
                            type: integer
                          rate:
                            type: number
                            nullable: true
                            description: Over reached recipients
                          median_seconds:
                            type: number
                            nullable: true
                            description: Median time from the send to the first response
                          by_channel:
                            type: array
                            items:
                              type: object
                              properties:
                                channel:
                                  type: string
                                count:
                                  type: integer
                      converted:
                        type: object
                        nullable: true
                        description: Null when the campaign has no conversion goal
                        properties:
                          event:
                            type: object
                            properties:
                              key:
                                type: string
                                example: order_created
                              stage_id:
                                type: string
                                format: uuid
                                nullable: true
                          count:
                            type: integer
                          rate:
                            type: number
                            nullable: true
                            description: Over reached recipients
                          median_seconds:
                            type: number
                            nullable: true
                          revenue:
                            type: object
                            nullable: true
                            properties:
                              value:
                                type: number
                              currency:
                                type: string
                                nullable: true
                              average_order_value:
                                type: number
                          direct:
                            type: object
                            description: Conversions attributed directly to the campaign
                            properties:
                              count:
                                type: integer
                              revenue:
                                type: number
                  steps:
                    type: array
                    description: Performance of each send step, in campaign order
                    items:
                      type: object
                      properties:
                        node_id:
                          format: uuid
                          type: string
                        step_number:
                          type: integer
                          description: Position among the campaign send steps
                        kind:
                          type: string
                          example: send-template
                        name:
                          type: string
                          nullable: true
                        channel:
                          type: string
                          enum:
                            - whatsapp
                            - email
                            - voice
                          nullable: true
                        counts:
                          type: object
                          description: Recipients per step status
                          properties:
                            pending:
                              type: integer
                            ongoing:
                              type: integer
                            succeeded:
                              type: integer
                            skipped:
                              type: integer
                            failed:
                              type: integer
                        reached:
                          type: integer
                          description: Recipients this step reached
                        responded_after:
                          type: integer
                          description: Recipients whose first response followed this step
                        converted_after:
                          type: integer
                          description: Recipients whose conversion followed this step
                        opted_out:
                          type: integer
                          nullable: true
                          description: Null when the step has no opt-out button
                        failures:
                          type: array
                          items:
                            type: object
                            properties:
                              reason:
                                type: string
                                nullable: true
                              recipients:
                                type: integer
                              level:
                                type: string
                                enum:
                                  - system
                                  - delivery
                                nullable: true
                        skips:
                          type: array
                          items:
                            type: object
                            properties:
                              reason:
                                type: string
                                nullable: true
                              recipients:
                                type: integer
                        email:
                          type: object
                          description: Email steps only
                          properties:
                            sent:
                              type: integer
                            delivered:
                              type: integer
                            opened:
                              type: integer
                            clicked:
                              type: integer
                            bounced:
                              type: integer
                            dropped:
                              type: integer
                            spam_reported:
                              type: integer
                            unsubscribed:
                              type: integer
                        voice:
                          type: object
                          description: Voice steps only
                          properties:
                            calls_made:
                              type: integer
                            answered:
                              type: integer
                            reached_human:
                              type: integer
                            objective_achieved:
                              type: integer
                            average_duration_seconds:
                              type: number
                              nullable: true
                            total_duration_seconds:
                              type: number
                            status_breakdown:
                              type: array
                              items:
                                type: object
                                properties:
                                  status:
                                    type: string
                                  count:
                                    type: integer
                            goal:
                              type: object
                              properties:
                                'yes':
                                  type: integer
                                'no':
                                  type: integer
                                partial:
                                  type: integer
        '404':
          description: Campaign not found

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.