Synupv1
Créer une clé
v1Ressources/Locations/getObtenir le résumé des emplacements

Obtenir le résumé des emplacements

Renvoie le nombre agrégé d'emplacements de toute votre agence (ou d'un client), ventilé par statut, niveau de forfait et statut de vérification.

get/api/v1/locations/summary
locations:read
Paramètres de requête
clientIdstringfacultatif
Limite aux emplacements d'un client. Omis, cela résume tous les emplacements que votre clé peut voir. Retrouvez-le avec GET /api/v1/clients.
tagsstringfacultatif
Limite aux emplacements portant l'une de ces étiquettes internes séparées par des virgules.
Réponse
dataobjectfacultatif
totalnumberfacultatif
Nombre total d'emplacements correspondants.
byStatusobjectfacultatif
Nombre d'emplacements regroupé par statut.
byVerificationobjectfacultatif
Nombre d'emplacements regroupé par statut de vérification.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/locations/summary
Votre clé API
clientId
tags
{
  "data": {
    "total": 12,
    "byStatus": {
      "approved": 10,
      "pending_verification": 1,
      "archival_pending": 1
    },
    "byVerification": {
      "verified": 9,
      "pending": 1,
      "unknown": 2
    }
  }
}