> ## Documentation Index > Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Obtener informe de la propuesta > Devuelve un informe de propuesta por ID, con metadatos de empresa, consultas generadas, competidores monitorizados, atributos de marca y competidores, principales fuentes citadas y métricas agregadas (menciones, sentimiento y porcentaje de respuestas). Requiere una **clave de API global (con alcance de organización)**. Las claves limitadas a sitios se rechazan con `403 Forbidden`. Devuelve `404 Not Found` si la propuesta no existe, está eliminada o es de otra organización. ## OpenAPI ````yaml es/api-reference/openapi.json get /api/v1/pitches/{pitch_id} openapi: 3.1.0 info: title: API de AthenaHQ description: >- La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web y consultas para optimizar el contenido con IA. version: 1.0.0 contact: email: support@athenahq.ai servers: - url: https://api.athenahq.ai description: Servidor de producción security: - apiKey: [] tags: - name: Basics description: Operaciones principales de la API para gestionar sitios web y consultas - name: Metrics description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA - name: Billing description: Endpoints de facturación y créditos para gestionar el uso - name: Team Management description: Endpoints para gestionar miembros del equipo e invitaciones - name: Groups description: Endpoints para gestionar grupos de sitios web - name: Content description: >- Endpoints para acceder a los datos del centro de contenidos: pestañas, URL monitorizadas y desglose de consultas por URL. - name: Pitch Workspace description: >- Endpoints para acceder a los informes del espacio de propuestas: ejecuciones de propuestas con alcance de organización, con competidores, consultas, atributos y métricas agregadas. - name: Knowledge Base description: >- Endpoints para leer la base de conocimientos de la marca: datos aprobados sobre la marca y los pilares que los organizan. paths: /api/v1/pitches/{pitch_id}: get: tags: - Pitch Workspace summary: Obtener informe de la propuesta description: >- Devuelve un informe de propuesta por ID, con metadatos de empresa, consultas generadas, competidores monitorizados, atributos de marca y competidores, principales fuentes citadas y métricas agregadas (menciones, sentimiento y porcentaje de respuestas). Requiere una **clave de API global (con alcance de organización)**. Las claves limitadas a sitios se rechazan con `403 Forbidden`. Devuelve `404 Not Found` si la propuesta no existe, está eliminada o es de otra organización. operationId: getPitch parameters: - name: pitch_id in: path description: UUID de la propuesta que se consultará. required: true schema: type: string format: uuid responses: '200': description: Respuesta correcta con el informe de propuesta completo. content: application/json: schema: $ref: '#/components/schemas/PitchReport' '400': description: 'Solicitud incorrecta: formato de `pitch_id` no válido.' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid pitch ID format '401': description: 'Sin autorización: falta la clave de API o no es válida.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Acceso denegado: se ha utilizado una clave de API limitada a un sitio web. Las propuestas son recursos de organización; usa una clave global. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: 'Forbidden: global API key required' '404': description: >- La propuesta no existe en la organización que realiza la llamada o se ha eliminado. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Pitch not found '500': description: Error interno del servidor. content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] components: schemas: PitchReport: type: object description: >- Datos del informe de propuesta completo devueltos por `GET /api/v1/pitches/{pitch_id}`. required: - pitch - competitors - prompts - attributes - sources - metrics properties: pitch: $ref: '#/components/schemas/PitchSummary' competitors: type: array items: $ref: '#/components/schemas/PitchCompetitor' description: >- Competidores monitorizados en la propuesta, con recuentos de menciones y sentimiento. prompts: type: array items: $ref: '#/components/schemas/PitchPrompt' description: Consultas generadas para la propuesta. attributes: type: array items: $ref: '#/components/schemas/PitchAttribute' description: >- Atributos positivos y negativos extraídos de las respuestas de la propuesta, tanto de la empresa objetivo como de sus competidores. sources: type: array items: $ref: '#/components/schemas/PitchSource' description: >- Los 10 dominios más citados en las respuestas de la propuesta, ordenados por número de menciones. metrics: $ref: '#/components/schemas/PitchMetrics' Error: type: object description: Objeto de respuesta de error required: - error properties: error: type: string description: Mensaje de error que describe qué ha fallado example: Unauthorized PitchSummary: type: object description: >- Informe del espacio de propuestas, con alcance de organización; se devuelve en listas sin los datos pesados del informe. required: - id - company_name - company_url - company_description - status - created_at properties: id: type: string format: uuid description: Identificador único de la propuesta. example: 123e4567-e89b-12d3-a456-426614174000 company_name: type: string description: Nombre visible de la empresa para la que se ha creado la propuesta. example: Acme Inc company_url: type: string description: Dominio del sitio web de la empresa (sin protocolo). example: acme.com company_description: type: string description: Descripción breve de la empresa recogida al crear la propuesta. example: Acme Inc sells durable industrial widgets to manufacturers. status: type: string enum: - draft - processing - completed - failed description: >- Estado actual de la ejecución de la propuesta. `processing` indica que aún se generan consultas y respuestas; `completed`, que el informe está listo; `failed`, que la ejecución ha fallado. example: completed created_at: type: string format: date-time description: Marca de tiempo ISO 8601 (UTC) de creación de la propuesta. example: '2026-05-22T15:04:05.000Z' country: type: string nullable: true description: >- País de destino de la propuesta, o `null` si no se ha definido ninguno. example: United States language: type: string nullable: true description: >- Idioma de destino de la propuesta, o `null` si no se ha definido ninguno. example: en type: type: string enum: - pitch_workspace - landing_page nullable: true description: >- Variante de propuesta. `pitch_workspace` es el informe estándar; `landing_page` se genera a partir de una URL de página de destino. `null` para propuestas anteriores a este campo. example: pitch_workspace PitchCompetitor: type: object description: >- Competidor monitorizado en una propuesta, con estadísticas agregadas de menciones y sentimiento de las respuestas de la propuesta. required: - id - name - url - mentions - sentiment properties: id: type: string format: uuid description: Identificador único de la fila del competidor de la propuesta. example: 11111111-2222-3333-4444-555555555555 name: type: string description: Nombre visible del competidor. example: Competitor Co url: type: string description: Sitio web del competidor (sin protocolo). example: competitor.com mentions: type: integer description: >- Número de respuestas de la propuesta en las que se ha mencionado a este competidor. example: 42 sentiment: type: integer description: >- Sentimiento medio de las menciones como porcentaje entero de 0 a 100. Las menciones `positive` cuentan como 1; `neutral`, como 0,5; `negative`, como 0. La media se convierte después en porcentaje. `0` si el competidor no tiene menciones. minimum: 0 maximum: 100 example: 67 PitchPrompt: type: object description: >- Consulta generada para una propuesta y utilizada para consultar modelos de IA. required: - id - prompt - type properties: id: type: string format: uuid description: Identificador único de la consulta de la propuesta. example: 22222222-3333-4444-5555-666666666666 prompt: type: string description: Instrucciones utilizadas para la generación. example: What are the best industrial widget manufacturers? type: type: string description: >- Categoría de consulta. Los valores habituales incluyen `discovery` y `high_intent`; pueden aparecer otros según la versión del generador de propuestas. example: discovery PitchAttribute: type: object description: >- Atributo (positivo o negativo) extraído de las respuestas de una propuesta, aplicado a la empresa objetivo o a sus competidores. required: - id - attribute_name - attribute_type - applies_to - count properties: id: type: string format: uuid description: Identificador único del atributo de la propuesta. example: 33333333-4444-5555-6666-777777777777 attribute_name: type: string description: Etiqueta del atributo. example: Reliable delivery attribute_type: type: string enum: - positive - negative description: Indica si el atributo es positivo o negativo. example: positive applies_to: type: string enum: - target - competitors description: >- Indica si el atributo describe a la empresa objetivo (`target`) o a uno de los competidores monitorizados (`competitors`). example: target count: type: integer description: Número de respuestas de la propuesta que mencionan este atributo. example: 12 PitchSource: type: object description: >- Una de las principales fuentes citadas (dominio raíz) en las respuestas de IA de la propuesta. required: - domain - mentions properties: domain: type: string description: >- Dominio raíz de la fuente citada. Las citas de Google Places se muestran como `google.com (Google Places)` para distinguirlas de las citas normales de `google.com`. example: wikipedia.org mentions: type: integer description: >- Número de filas de fuentes de la propuesta atribuidas a este dominio. example: 18 PitchMetrics: type: object description: >- Métricas agregadas calculadas a partir de las respuestas de IA de la propuesta. required: - total_responses - brand_mentions - sentiment_score - response_rate properties: total_responses: type: integer description: Número total de respuestas de IA recopiladas para esta propuesta. example: 120 brand_mentions: type: integer description: >- Número de respuestas en las que se ha mencionado a la empresa objetivo. example: 64 sentiment_score: type: integer description: >- Sentimiento medio de las respuestas con menciones como porcentaje entero de 0 a 100. `positive` cuenta como 1; `neutral`, como 0,5; `negative`, como 0. La media se convierte después en porcentaje. `0` si no hay menciones de marca. minimum: 0 maximum: 100 example: 72 response_rate: type: integer description: >- Proporción de respuestas que mencionan a la empresa objetivo, expresada como un porcentaje entero de 0 a 100 (`brand_mentions / total_responses`). minimum: 0 maximum: 100 example: 53 securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- Clave de API para autenticarse. Puedes crear una [aquí](https://app.athenahq.ai/organization?tab=api). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.