> ## 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. # Interroger les réponses > Renvoie les réponses IA paginées d’un site, filtrables par dates, modèles, prompts, concurrents et requêtes de recherche ayant produit chaque réponse. ## OpenAPI ````yaml fr/api-reference/openapi.json post /api/v1/responses 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/responses: post: tags: - Basics summary: Interroger les réponses description: >- Renvoie les réponses IA paginées d’un site, filtrables par dates, modèles, prompts, concurrents et requêtes de recherche ayant produit chaque réponse. operationId: queryResponses requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponsesRequest' responses: '200': description: Réponse réussie avec la liste des réponses content: application/json: schema: type: object properties: responses: type: array items: $ref: '#/components/schemas/Response' required: - responses '400': description: Requête incorrecte — paramètres invalides content: application/json: schema: $ref: '#/components/schemas/Error' examples: invalid_json: value: error: Invalid JSON in request body missing_website_id: value: error: 'website_id: Required' missing_filters: value: error: 'filters: Required' '401': description: Non autorisé — clé API invalide ou absente content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Interdit — aucun accès au site, prompts ou concurrents content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized_website: value: error: Unauthorized access to this website unauthorized_prompts: value: error: Unauthorized access to these prompts unauthorized_competitors: value: error: Unauthorized access to these competitors '500': description: Erreur interne du serveur content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] components: schemas: ResponsesRequest: type: object description: Corps de la requête pour interroger les réponses required: - website_id - filters properties: website_id: type: string format: uuid description: ID du site dont interroger les réponses example: 123e4567-e89b-12d3-a456-426614174000 filters: $ref: '#/components/schemas/ResponsesApiFilters' page_num: type: integer minimum: 0 default: 0 description: Numéro de page à partir de zéro example: 0 page_size: type: integer minimum: 1 maximum: 100 default: 40 description: Réponses par page example: 40 include_response: type: boolean default: true description: >- Inclut le texte intégral sur chaque ligne. Avec `false`, omet entièrement `response`, partie la plus lourde, si seuls prompt, variante et scores vous intéressent. example: false compact_sources: type: boolean default: false description: >- Remplace les objets `sources` par source par `source_domains`, liste dédupliquée et triée des domaines racines. À utiliser si les domaines suffisent sans leurs URL exactes. example: false Response: type: object description: Réponse d’un modèle IA required: - schedule - id - website_id - prompt_id - base_prompt - prompt - model - mentioned - cited - created_at - competitors properties: schedule: description: >- Provenance de la planification de collecte : default (historique ancien et exécutions ponctuelles inclus) ou UUID d’une planification personnalisée/archivée. Utilise la valeur de sélection du catalogue, pas un UUID de planification standard. oneOf: - type: string enum: - default - type: string format: uuid example: default id: type: string format: uuid description: Identifiant unique de la réponse example: 123e4567-e89b-12d3-a456-426614174000 website_id: type: string format: uuid description: ID du site associé example: 123e4567-e89b-12d3-a456-426614174000 prompt_id: type: string format: uuid description: ID du prompt associé example: 123e4567-e89b-12d3-a456-426614174000 base_prompt: type: string description: Texte original du prompt example: What is the best CRM software? prompt: type: string description: Variante réellement utilisée du prompt example: What is the best CRM software for small businesses? model: type: string description: Modèle IA ayant généré la réponse example: chatgpt response: type: string description: Texte de la réponse IA. Omis si `include_response` vaut `false`. example: Here are some top CRM options... mentioned: type: boolean description: Indique si votre site web a été mentionné dans la réponse example: true position: type: integer nullable: true description: Rang/position de votre site dans la réponse, null sans mention example: 2 cited: type: boolean description: Indique si votre site a été cité comme source example: true created_at: type: string format: date-time description: Horodatage de capture de la réponse (UTC) example: '2024-06-15T10:30:00.000Z' sources: type: array description: >- Sources citées dans la réponse. Omis si `compact_sources` vaut `true` ; remplacé par `source_domains`. items: $ref: '#/components/schemas/Source' source_domains: type: array description: >- Domaines racines cités dans la réponse, dédupliqués et triés alphabétiquement. Les hôtes sont en minuscules et sans `www.` initial ; les sous-domaines sont conservés, donc `shop.example.com` reste distinct de `example.com`. Présent uniquement si `compact_sources` vaut `true`. items: type: string example: - example.com - runnersworld.com competitors: type: array description: Concurrents mentionnés dans la réponse items: $ref: '#/components/schemas/ResponseCompetitor' Error: type: object description: Objet de réponse d’erreur required: - error properties: error: type: string description: Message expliquant l’erreur example: Unauthorized ResponsesApiFilters: allOf: - $ref: '#/components/schemas/ApiFilters' - type: object description: Filtres supplémentaires propres aux réponses. properties: has_search_queries: type: boolean description: >- Filtre selon l’utilisation par le modèle d’au moins une recherche web ou cartographique non vide. search_query_text: type: string description: >- Texte à rechercher sans tenir compte de la casse dans les recherches web/cartographiques d’une réponse. search_query_text_operator: type: string enum: - contains - does_not_contain default: contains description: Mode de correspondance de search_query_text. Source: type: object description: Source citée dans une réponse IA required: - url - root_domain properties: url: type: string description: URL de la source example: example.com/article normalized_url: type: string nullable: true description: Version normalisée de l’URL example: example.com/article root_domain: type: string description: Domaine racine de la source example: example.com suffix: type: string nullable: true description: Suffixe de domaine example: .com ResponseCompetitor: type: object description: Concurrent mentionné dans une réponse IA required: - id - name - url - position properties: id: type: string format: uuid description: ID du concurrent example: 123e4567-e89b-12d3-a456-426614174000 name: type: string description: Nom du concurrent example: Competitor Inc url: type: string description: URL du concurrent example: competitor.com position: type: integer description: Position/rang du concurrent mentionné dans la réponse example: 1 ApiFilters: type: object description: >- Filtres pour interroger les réponses et les indicateurs. Transmettez les filtres d’emplacements dans le corps JSON comme `filters.location_ids`. required: - start_date properties: schedule_id: $ref: '#/components/schemas/PromptScheduleSelection' start_date: type: string format: date-time description: Date de début du filtre (UTC) example: '2024-01-01T00:00:00.000Z' end_date: type: string format: date-time description: Date de fin du filtre (UTC) example: '2024-12-31T23:59:59.999Z' models: type: array description: Filtrer par modèles IA items: type: string enum: - chatgpt - perplexity - gemini - google_ai_overview - copilot - claude - ai_mode - grok - deepseek - meta_ai - mistral example: - chatgpt - perplexity prompt_ids: type: array description: Filtrer par ID de prompts précis items: type: string format: uuid competitor_ids: type: array description: Filtrer par ID de concurrents précis items: type: string format: uuid location_ids: type: array description: >- Filtre par ID d’emplacement dans le corps JSON sous `filters.location_ids`, même pour un seul. Utilisez les ID de `GET /api/v1/locations`. items: type: string format: uuid example: - 123e4567-e89b-12d3-a456-426614174111 prompt_status: type: string enum: - active - paused description: Filtrer par statut du prompt prompt_type: type: string enum: - branded - non_branded description: Filtrer par type de prompt PromptScheduleSelection: description: >- Sélectionnez une planification de collecte, avec la valeur renvoyée par GET /api/v1/prompt-schedules. Par défaut inclut l’historique antérieur à la transition et les exécutions ponctuelles ; les planifications archivées conservent leurs résultats. L’ancien jeton manual est accepté comme alias de default. Ce champ accepte une seule planification ; une liste renvoie 400. default: default oneOf: - type: string enum: - default - manual - type: string format: uuid 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.