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

# Detalhe de uma campanha

> Recupera toda la información detallada de una campaña específica por su ID.



## OpenAPI

````yaml GET /api/v2/campaigns/{campaign_id}/
openapi: 3.0.0
info:
  title: API Inceptia
  description: API para la consulta de campañas, casos y llamadas de un bot.
  version: 2.0.0
servers:
  - url: https://admintest.inceptia.ai/
    description: Ambiente de pruebas
  - url: https://admin.inceptia.ai/
    description: Ambiente productivo
security: []
tags:
  - name: Autenticación
    description: Endpoints para la autenticación de usuarios y gestión de tokens.
  - name: Bots
    description: Endpoints para operaciones relacionadas con los bots.
  - name: Campañas
    description: Endpoints para operaciones relacionadas con las campañas.
  - name: Casos de campaña
    description: Endpoints para operaciones relacionadas con los casos de campaña.
  - name: Llamadas de campaña
    description: Endpoints para operaciones relacionadas con las llamadas de campaña.
  - name: Casos de inbound
    description: Endpoints para operaciones relacionadas con los casos de inbound.
paths:
  /api/v2/campaigns/{campaign_id}/:
    get:
      tags:
        - Campañas
      summary: Obtener detalles de una campaña
      description: >-
        Recupera toda la información detallada de una campaña específica por su
        ID.
      parameters:
        - name: campaign_id
          in: path
          description: ID de la campaña a obtener.
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Información detallada de la campaña.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignDetail'
        '401':
          description: No autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          description: La campaña no fue encontrada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No encontrado.
      security:
        - jwtAuth: []
components:
  schemas:
    CampaignDetail:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
          nullable: true
        bot:
          type: integer
        conversation_type:
          type: string
        closes_eod:
          type: boolean
        params:
          type: object
          properties:
            call_from:
              type: string
              format: time
            call_to:
              type: string
              format: time
            max_calls_per_case:
              type: integer
            dialing_type:
              type: string
            workers:
              type: integer
            max_phone_priority:
              type: integer
            min_phone_priority:
              type: integer
            start_date:
              type: string
              format: date
        case_stats:
          type: object
          properties:
            q_loaded_cases:
              type: integer
            q_filtered_cases:
              type: integer
            q_resting_cases:
              type: integer
            q_final_cases:
              type: integer
        metrics:
          type: object
          properties:
            status:
              type: string
            percentage_completed:
              type: integer
            percentage_called:
              type: integer
            success_rate:
              type: string
            contactability_rate:
              type: integer
            bot_duration:
              type: string
              nullable: true
            hours:
              type: number
              format: float
        created_at:
          type: string
          format: date-time
    UnauthorizedError:
      type: object
      properties:
        token:
          type: string
      example:
        token: El token es inválido o ha expirado
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso JWT. Debe ser enviado como 'Bearer {token}'.

````