Lister les prompts

curl --request GET \
  --url https://www.qwairy.co/api/v1/brands/{brandId}/prompts \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "prompts": [
    {
      "id": "<string>",
      "text": "<string>",
      "topic": "<string>",
      "type": "<string>",
      "tags": [
        {}
      ],
      "personas": [
        {}
      ],
      "modelIds": [
        {}
      ],
      "monitoringEnabled": true,
      "frequency": {},
      "frequencyInherited": true,
      "boostCount": 123,
      "answersCount": 123,
      "mentionRate": 123,
      "sourceRate": 123,
      "lastGeneratedAt": "<string>",
      "competitors": [
        {}
      ],
      "competitorsCount": 123,
      "competitorMentionsTotal": 123,
      "brandMentioned": true,
      "brandMentionCount": 123,
      "sources": [
        {}
      ],
      "sourcesCount": 123,
      "sourceCitationsTotal": 123,
      "sourceStability": 123,
      "createdAt": "<string>"
    }
  ]
}

GET

https://www.qwairy.co

api

brands

{brandId}

prompts

Lister les prompts

curl --request GET \
  --url https://www.qwairy.co/api/v1/brands/{brandId}/prompts \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://www.qwairy.co/api/v1/brands/{brandId}/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "pagination": {
    "total": 123,
    "count": 123,
    "limit": 123,
    "offset": 123
  },
  "prompts": [
    {
      "id": "<string>",
      "text": "<string>",
      "topic": "<string>",
      "type": "<string>",
      "tags": [
        {}
      ],
      "personas": [
        {}
      ],
      "modelIds": [
        {}
      ],
      "monitoringEnabled": true,
      "frequency": {},
      "frequencyInherited": true,
      "boostCount": 123,
      "answersCount": 123,
      "mentionRate": 123,
      "sourceRate": 123,
      "lastGeneratedAt": "<string>",
      "competitors": [
        {}
      ],
      "competitorsCount": 123,
      "competitorMentionsTotal": 123,
      "brandMentioned": true,
      "brandMentionCount": 123,
      "sources": [
        {}
      ],
      "sourcesCount": 123,
      "sourceCitationsTotal": 123,
      "sourceStability": 123,
      "createdAt": "<string>"
    }
  ]
}

Liste les prompts suivis avec le nombre de réponses et les indicateurs SELF au niveau des réponses. Un prompt peut avoir une étape du tunnel, un Topic et des Tags.

Consultez Entités pour la structure complète de l’objet Prompt, et Topic / Tag pour les objets de classement.

string

requis

Jeton bearer. Exemple : Bearer qw-api-xxx

Paramètres de chemin

string

requis

L’identifiant unique de la marque

Paramètres de requête

number

Nombre de jours à inclure. Renvoie les prompts ayant reçu au moins une réponse dans la fenêtre. Sans valeur, toutes les données sont renvoyées.

string

Date de début au format YYYY-MM-DD (par exemple 2026-03-05). Fournissez-la avec endDate ; une borne seule est actuellement ignorée. Choisissez soit period, soit la paire de dates complète.

string

Date de fin au format YYYY-MM-DD (par exemple 2026-03-31). Fournissez-la avec startDate ; une borne seule est actuellement ignorée. Ne combinez pas la paire de dates complète avec period.

Avec une plage de dates, la liste des prompts et les agrégats include=details par prompt (answersCount, competitors[].mentions, brandMentionCount, sources[].citations) sont limités à cette fenêtre. Les prompts exécutés plusieurs fois apparaissent dès qu’au moins une de leurs exécutions tombe dans la plage.

string

Filtre par identifiant de Topic (keywordId). Accepte plusieurs valeurs séparées par des virgules (par exemple id1,id2).

string

Filtre par identifiant de Tag. Accepte plusieurs valeurs séparées par des virgules (par exemple id1,id2).

string

Filtre par type de prompt : TOFU, MOFU, BOFU ou POST_PURCHASE

string

UUID de Personas actuellement rattachées au prompt, séparés par des virgules. Utilisez default pour les prompts sans Persona, ou all pour ne pas filtrer.

string

Codes ISO 3166-1 alpha-2 séparés par des virgules (par exemple FR,BE). Conserve les prompts dont les pays configurés effectifs incluent l’un d’eux ; ce n’est pas le pays des réponses passées. 50 codes au maximum ; un code invalide renvoie 400.

number

défaut:"50"

Nombre maximal de prompts renvoyés (maximum : 100)

number

défaut:"0"

Décalage de pagination

string

défaut:"lastGeneratedAt"

Champ de tri : lastGeneratedAt, answersCount, text, createdAt

string

défaut:"desc"

Ordre de tri : asc ou desc

string

Indiquez details pour enrichir chaque prompt avec les agrégats de concurrents, de sources, de mentions de la marque et de stabilité des sources. Sans ce paramètre, la réponse ne contient que les champs de base listés ci-dessous.

Réponse

boolean

Indique si la requête a réussi

object

Afficher Informations de pagination

number

Nombre total de prompts correspondant aux filtres

number

Nombre de prompts dans cette réponse

number

Nombre maximal d’éléments par page

number

Nombre d’éléments ignorés

array

Afficher Objet Prompt

string

Identifiant du prompt

string

Texte du prompt

string

Nom du Topic associé

string

Type de prompt (TOFU/MOFU/BOFU/POST_PURCHASE)

array

Liste des noms de Tags

array

Personas actuellement rattachées au prompt (id, name, description)

array

Identifiants des modèles actuellement configurés sur le prompt

boolean

Indique si le suivi planifié est activé

string | null

Fréquence de suivi effective : NONE, DAILY, WEEKLY ou MONTHLY

boolean

Indique si la fréquence est héritée de la valeur par défaut de la marque

number

Réponses demandées par modèle et par exécution

number

Nombre de réponses générées

number

Réponses avec une mention SELF divisées par les réponses avec une mention SELF ou DIRECT

number

Réponses avec une citation SELF divisées par les réponses avec une citation SELF ou DIRECT

string

Horodatage de la dernière génération (ISO 8601)

Afficher Champs supplémentaires avec include=details

array

Liste des concurrents mentionnés dans l’ensemble des réponses de ce prompt. Chaque objet contient name (string), mentions (number) et relationship (SELF, DIRECT, INDIRECT).

number

Nombre de concurrents distincts mentionnés

number

Total des mentions de concurrents dans l’ensemble des réponses

boolean

Indique si votre marque a été mentionnée dans au moins une réponse

number

Nombre de fois où votre marque a été mentionnée

array

Liste des domaines sources cités dans l’ensemble des réponses de ce prompt. Chaque objet contient domain (string), citations (number) et isSelf (boolean).

number

Nombre de domaines sources distincts cités

number

Total des citations de sources dans l’ensemble des réponses

number

Pourcentage des domaines sources distincts présents dans chaque réponse du périmètre lorsqu’il y a plus d’une réponse ; sinon 0

string

Horodatage de création du prompt (ISO 8601)

Exemple de requête

curl "https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/prompts?type=TOFU&limit=10" \
  -H "Authorization: Bearer $QWAIRY_API_TOKEN"

Exemple de réponse

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 1,
    "limit": 10,
    "offset": 0
  },
  "prompts": [
    {
      "id": "prompt_01",
      "text": "Which analytics platforms support warehouse exports?",
      "topic": "Data exports",
      "type": "TOFU",
      "tags": ["reviews", "comparison"],
      "answersCount": 2,
      "mentionRate": 50.0,
      "sourceRate": 25.0,
      "lastGeneratedAt": "2026-07-19T10:00:00.000Z"
    }
  ]
}

Exemple de réponse avec `include=details`

curl "https://www.qwairy.co/api/v1/brands/YOUR_BRAND_ID/prompts?include=details&limit=10" \
  -H "Authorization: Bearer $QWAIRY_API_TOKEN"

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 1,
    "limit": 10,
    "offset": 0
  },
  "prompts": [
    {
      "id": "prompt_01",
      "text": "Which analytics platforms support warehouse exports?",
      "topic": "Data exports",
      "type": "TOFU",
      "tags": ["reviews", "comparison"],
      "answersCount": 2,
      "mentionRate": 50.0,
      "sourceRate": 25.0,
      "lastGeneratedAt": "2024-12-19T10:00:00.000Z",
      "competitors": [
        { "name": "Acme Analytics", "mentions": 3, "relationship": "SELF" },
        { "name": "Rival Labs", "mentions": 8, "relationship": "DIRECT" },
        { "name": "Northstar Data", "mentions": 5, "relationship": "DIRECT" }
      ],
      "competitorsCount": 3,
      "competitorMentionsTotal": 16,
      "brandMentioned": true,
      "brandMentionCount": 3,
      "sources": [
        { "domain": "acme.example", "citations": 2, "isSelf": true },
        { "domain": "reviews.example", "citations": 4, "isSelf": false },
        { "domain": "publisher.example", "citations": 3, "isSelf": false }
      ],
      "sourcesCount": 3,
      "sourceCitationsTotal": 9,
      "sourceStability": 33.33,
      "createdAt": "2026-07-01T10:00:00.000Z"
    }
  ]
}

Erreurs

Statut	Signification
`400`	Paramètre de requête invalide
`401`	Jeton d’API manquant ou invalide
`404`	Marque introuvable ou inaccessible
`429`	Limite de débit dépassée ; respectez `Retry-After`

Consultez Limites de débit pour la gestion des nouvelles tentatives.

Bien démarrer

Configurer les données

Suivi et mesure

Analyse et action

Agence et automatisation

Guides d’implémentation

Lister les prompts

Paramètres de chemin

Paramètres de requête

Réponse

Exemple de requête

Exemple de réponse

Exemple de réponse avec `include=details`

Erreurs

​Paramètres de chemin

​Paramètres de requête

​Réponse

​Exemple de requête

​Exemple de réponse

​Exemple de réponse avec include=details

​Erreurs

Paramètres de chemin

Paramètres de requête

Réponse

Exemple de requête

Exemple de réponse

Exemple de réponse avec `include=details`

Erreurs