> ## 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. # Obtenir un rapport de proposition > Renvoie un rapport de proposition par ID : entreprise, prompts générés, concurrents, attributs de marque/concurrents, principales sources et agrégats (mentions, sentiment, taux de réponse). Exige une **clé globale à l’échelle de l’organisation**. Clés limitées aux sites : `403 Forbidden`. `404 Not Found` si rapport inexistant, supprimé ou d’une autre organisation. ## OpenAPI ````yaml fr/api-reference/openapi.json get /api/v1/pitches/{pitch_id} openapi: 3.1.0 info: title: API AthenaHQ description: >- L’API AthenaHQ permet de gérer vos sites et prompts par programme pour l’optimisation de contenu par IA. version: 1.0.0 contact: email: support@athenahq.ai servers: - url: https://api.athenahq.ai description: Serveur de production security: - apiKey: [] tags: - name: Basics description: Opérations API principales pour gérer sites et prompts - name: Metrics description: Points de terminaison de métriques et analyses de visibilité IA - name: Billing description: Points de facturation et crédits pour gérer la consommation - name: Team Management description: Points de terminaison de gestion des membres et invitations - name: Groups description: Points de terminaison de gestion des groupes de sites - name: Content description: >- Points de terminaison Content Hub : onglets, URL suivies et détail des prompts par URL. - name: Pitch Workspace description: >- Points de terminaison des rapports Pitch Workspace : exécutions à l’échelle de l’organisation avec concurrents, prompts, attributs et métriques agrégées. - name: Knowledge Base description: >- Endpoints de lecture de la base de connaissances de la marque — faits approuvés et piliers qui les organisent. paths: /api/v1/pitches/{pitch_id}: get: tags: - Pitch Workspace summary: Obtenir un rapport de proposition description: >- Renvoie un rapport de proposition par ID : entreprise, prompts générés, concurrents, attributs de marque/concurrents, principales sources et agrégats (mentions, sentiment, taux de réponse). Exige une **clé globale à l’échelle de l’organisation**. Clés limitées aux sites : `403 Forbidden`. `404 Not Found` si rapport inexistant, supprimé ou d’une autre organisation. operationId: getPitch parameters: - name: pitch_id in: path description: UUID de la proposition à récupérer. required: true schema: type: string format: uuid responses: '200': description: Réponse réussie avec le rapport de proposition complet. content: application/json: schema: $ref: '#/components/schemas/PitchReport' '400': description: Requête incorrecte — format de `pitch_id` invalide. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid pitch ID format '401': description: Non autorisé — clé API invalide ou absente. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Interdit — une clé API limitée à certains sites a été utilisée. Les pitchs sont des ressources de l’organisation ; utilisez une clé API globale. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: 'Forbidden: global API key required' '404': description: Proposition absente de l’organisation appelante ou supprimée. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Pitch not found '500': description: Erreur interne du serveur. content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] components: schemas: PitchReport: type: object description: Rapport complet renvoyé par `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: Concurrents suivis dans la proposition, avec mentions et sentiment. prompts: type: array items: $ref: '#/components/schemas/PitchPrompt' description: Prompts générés pour le pitch. attributes: type: array items: $ref: '#/components/schemas/PitchAttribute' description: >- Attributs positifs/négatifs extraits des réponses de proposition pour l’entreprise cible et ses concurrents. sources: type: array items: $ref: '#/components/schemas/PitchSource' description: >- Dix principaux domaines cités dans les réponses de proposition, par nombre de mentions. metrics: $ref: '#/components/schemas/PitchMetrics' Error: type: object description: Objet de réponse d’erreur required: - error properties: error: type: string description: Message expliquant l’erreur example: Unauthorized PitchSummary: type: object description: >- Rapport Pitch Workspace d’organisation, listé sans données lourdes du rapport. required: - id - company_name - company_url - company_description - status - created_at properties: id: type: string format: uuid description: Identifiant unique de la proposition. example: 123e4567-e89b-12d3-a456-426614174000 company_name: type: string description: Nom d’affichage de l’entreprise cible de la proposition. example: Acme Inc company_url: type: string description: Domaine du site de l’entreprise sans protocole. example: acme.com company_description: type: string description: >- Brève description de l’entreprise capturée lors de la création du pitch. example: Acme Inc sells durable industrial widgets to manufacturers. status: type: string enum: - draft - processing - completed - failed description: >- État de la proposition : `processing`, génération de prompts et réponses ; `completed`, rapport prêt ; `failed`, exécution en erreur. example: completed created_at: type: string format: date-time description: Horodatage ISO 8601 (UTC) de création du pitch. example: '2026-05-22T15:04:05.000Z' country: type: string nullable: true description: Pays cible de la proposition, ou `null` sans pays défini. example: United States language: type: string nullable: true description: Langue cible de la proposition, ou `null` sans langue définie. example: en type: type: string enum: - pitch_workspace - landing_page nullable: true description: >- Variante : `pitch_workspace` pour le rapport standard ; `landing_page` depuis une page de destination ; `null` pour les propositions antérieures à ce champ. example: pitch_workspace PitchCompetitor: type: object description: >- Concurrent de proposition avec statistiques agrégées de mention et sentiment sur les réponses. required: - id - name - url - mentions - sentiment properties: id: type: string format: uuid description: Identifiant unique de la ligne de concurrent de proposition. example: 11111111-2222-3333-4444-555555555555 name: type: string description: Nom d’affichage du concurrent. example: Competitor Co url: type: string description: Site concurrent sans protocole. example: competitor.com mentions: type: integer description: Nombre de réponses du pitch mentionnant ce concurrent. example: 42 sentiment: type: integer description: >- Sentiment moyen des mentions, exprimé en pourcentage entier de 0 à 100. Les mentions `positive` comptent pour 1, `neutral` pour 0,5 et `negative` pour 0 ; la moyenne est ensuite convertie en pourcentage. `0` lorsque le concurrent n’a aucune mention. minimum: 0 maximum: 100 example: 67 PitchPrompt: type: object description: Prompt généré pour une proposition et soumis aux modèles IA. required: - id - prompt - type properties: id: type: string format: uuid description: Identifiant unique du prompt de proposition. example: 22222222-3333-4444-5555-666666666666 prompt: type: string description: Texte du prompt utilisé pour la génération. example: What are the best industrial widget manufacturers? type: type: string description: >- Catégorie du prompt. Valeurs courantes : `discovery`, `high_intent` ; d’autres sont possibles selon la version du générateur. example: discovery PitchAttribute: type: object description: >- Attribut positif ou négatif extrait des réponses de proposition, appliqué à l’entreprise cible ou ses concurrents. required: - id - attribute_name - attribute_type - applies_to - count properties: id: type: string format: uuid description: Identifiant unique de l’attribut du pitch. example: 33333333-4444-5555-6666-777777777777 attribute_name: type: string description: Libellé de l’attribut. example: Reliable delivery attribute_type: type: string enum: - positive - negative description: Indique si l’attribut est positif ou négatif. example: positive applies_to: type: string enum: - target - competitors description: >- Indique si l’attribut décrit l’entreprise cible (`target`) ou un concurrent suivi (`competitors`). example: target count: type: integer description: Nombre de réponses du pitch mentionnant cet attribut. example: 12 PitchSource: type: object description: >- Principale source citée (domaine racine) dans les réponses IA de la proposition. required: - domain - mentions properties: domain: type: string description: >- Domaine racine de la source citante. Les citations Google Places s’affichent sous `google.com (Google Places)` pour les distinguer des citations `google.com` ordinaires. example: wikipedia.org mentions: type: integer description: Nombre de lignes de sources du pitch attribuées à ce domaine. example: 18 PitchMetrics: type: object description: Métriques agrégées sur les réponses IA de la proposition. required: - total_responses - brand_mentions - sentiment_score - response_rate properties: total_responses: type: integer description: Nombre total de réponses IA recueillies pour la proposition. example: 120 brand_mentions: type: integer description: Nombre de réponses mentionnant l’entreprise cible. example: 64 sentiment_score: type: integer description: >- Sentiment moyen des réponses comportant une mention, exprimé en pourcentage entier de 0 à 100. `positive` compte pour 1, `neutral` pour 0,5 et `negative` pour 0 ; la moyenne est ensuite convertie en pourcentage. `0` en l’absence de mention de marque. minimum: 0 maximum: 100 example: 72 response_rate: type: integer description: >- Part des réponses mentionnant l’entreprise cible, en pourcentage entier de 0 à 100 (`brand_mentions / total_responses`). minimum: 0 maximum: 100 example: 53 securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- Clé API d’authentification. Créez-en une [ici](https://app.athenahq.ai/organization?tab=api). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.