Skip to main content

Endpoint & Authentification

En-têtes (Headers) :
  • x-api-key: [VOTRE_API_KEY]
La clé API est propre à chaque partenaire et n’est autorisée que sur les agences qui lui ont été attribuées. Les statistiques renvoyées sont limitées à l’agence indiquée dans agency_id.

Paramètres de la requête (Body)

string
required
Identifiant unique de l’agence. Les statistiques sont calculées uniquement sur cette agence, qui doit faire partie des agences autorisées pour votre clé.
date
Date de création de début.
date
Date de création de fin.
string
Type d’affaire. Valeurs possibles : Contrat, Réparation, Modernisation pour devis, Remplacement complet pour devis, Modernisation pour commande, Remplacement complet pour commande.
string
Catégorie de l’affaire. Valeurs possibles : Ouverte, En attente, En retard, Gagnée, Perdue, Annulée, Fermée.

Réponse

L’API retourne un objet contenant le nombre d’affaires correspondant aux critères.