Introduction

Utilisez l’API v1 pour lire les données de suivi accessibles à votre équipe : réponses, citations, concurrents et indicateurs agrégés.

L’API v1 exige une offre Growth, Business ou Enterprise active, ou une offre Agency Growth ou Agency Business. Vérifiez votre abonnement si l’authentification signale une offre insuffisante.

URL de base

Tous les endpoints de l’API sont relatifs à :

https://www.qwairy.co/api/v1

Endpoints disponibles

L’API expose ces ressources de suivi :

Ressource	Description
Marques	Lister toutes les marques de votre compte
Performance	Lire les indicateurs de visibilité au niveau des réponses
Concurrents	Suivre les mentions des concurrents et la part de voix
Domaines sources	Suivre les domaines cités par les plateformes IA
URL sources	Suivre chaque page citée dans les réponses IA
Prompts	Accéder aux prompts suivis
Réponses	Récupérer les réponses IA enregistrées
Recherche	Lister le Query Fan-Out conservé associé aux réponses enregistrées

Démarrage rapide

Obtenez votre jeton d’API

Ouvrez Gestion de l’équipe → API REST et créez un nouveau jeton d’API.

Faites votre première requête

curl -X GET "https://www.qwairy.co/api/v1/brands" \
  -H "Authorization: Bearer qw-api-your-token-here"

Explorez vos données

Utilisez l’identifiant de marque pour accéder aux indicateurs de performance, aux concurrents, aux sources, etc.

Format des réponses

Les réponses sont au format JSON. Les endpoints de liste renvoient en général un tableau de ressources et un objet pagination :

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 10,
    "limit": 10,
    "offset": 0
  },
  "prompts": [ ... ]
}

La plupart des endpoints de liste incluent un objet pagination avec :

total : nombre total d’éléments correspondant à la requête
count : éléments de cette réponse
limit : nombre maximal d’éléments par page
offset : éléments ignorés

L’endpoint /brands fait exception : il renvoie la liste complète avec un total au premier niveau et sans objet pagination. Consultez Entités pour le détail des structures de données. Les erreurs de validation et de ressource incluent des codes exploitables par programme :

{
  "error": {
    "code": "BRAND_NOT_FOUND",
    "message": "Brand not found or not accessible"
  }
}

Les erreurs d’authentification et de limite de débit ont une forme plate. Consultez Codes d’erreur avant de mettre en place la gestion des erreurs.

Obtenir de l’aide

Consultez le guide Authentification
Lisez Limites de débit
Consultez Codes d’erreur
Écrivez-nous à team@qwairy.co

Bien démarrer

Configurer les données

Suivi et mesure

Analyse et action

Agence et automatisation

Guides d’implémentation

URL de base

Endpoints disponibles

Démarrage rapide

Format des réponses

Obtenir de l’aide

​URL de base

​Endpoints disponibles

​Démarrage rapide

​Format des réponses

​Obtenir de l’aide

URL de base

Endpoints disponibles

Démarrage rapide

Format des réponses

Obtenir de l’aide