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

# Get Campaign Results

> Returns the campaign distribution



## OpenAPI

````yaml GET /v2/campaign-results/
openapi: 3.1.0
info:
  title: CloserX.ai API
  description: >-
    The CloserX.ai API provides programmatic access to manage AI-powered calling
    operations, including agent creation, campaign management, contact handling,
    telephony integration, and more. This API enables seamless automation and
    integration with CRM systems, telephony providers, and other third-party
    services for enhanced client communication and business operations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://app.closerx.ai/api
security:
  - api_key: []
paths:
  /v2/campaign-results/:
    get:
      description: Returns the campaign distribution
      parameters:
        - name: Company-Name
          in: header
          description: The name of the schema to be used for the request
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dashboard data response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardCampaignResult'
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DashboardCampaignResult:
      type: object
      required:
        - count
        - next
        - previous
        - results
      properties:
        count:
          type: integer
          description: Total number of campaign results
        next:
          type: string
          nullable: true
          description: URL to the next page of results
        previous:
          type: string
          nullable: true
          description: URL to the previous page of results
        results:
          type: array
          description: Array of campaign result objects
          items:
            type: object
            required:
              - id
              - sid
              - full_name
              - contact_number
              - call_duration
              - status
              - appointment_booked
              - outcome
              - contact_id
              - direction
              - recording_url
              - transcription
              - transcription_text
              - notes
              - improvement_tags
              - credit_deduction
              - errors
              - calender_id
              - response_sentiment
              - created_at
              - updated_at
              - campaign
            properties:
              id:
                type: integer
                description: Unique identifier for the campaign result
              sid:
                type: string
                nullable: true
                description: Session ID
              full_name:
                type: string
                description: Full name of the contact
              contact_number:
                type: string
                description: Contact phone number
              call_duration:
                type: integer
                description: Duration of the call in seconds
              status:
                type: string
                description: Status of the call
              appointment_booked:
                type: boolean
                description: Indicates if an appointment was booked
              outcome:
                type: string
                description: Outcome of the campaign
              contact_id:
                type: integer
                nullable: true
                description: ID of the contact
              direction:
                type: string
                description: Direction of the call (inbound/outbound)
              recording_url:
                type: string
                nullable: true
                description: URL to the call recording
              transcription:
                type: array
                description: Array of transcription data
                items:
                  type: string
              transcription_text:
                type: string
                description: Full transcription text
              notes:
                type: string
                description: Additional notes for the campaign
              improvement_tags:
                type: array
                description: Array of tags for improvement
                items:
                  type: string
              credit_deduction:
                type: string
                description: Credit deduction details
              errors:
                type: string
                description: Any errors encountered
              calender_id:
                type: integer
                nullable: true
                description: Calendar ID associated with the call
              response_sentiment:
                type: string
                description: Sentiment of the response
              created_at:
                type: string
                description: Timestamp when the result was created
              updated_at:
                type: string
                description: Timestamp when the result was last updated
              campaign:
                type: string
                description: Name or ID of the campaign
    Error:
      required:
        - success
        - message
        - data
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key

````