v1Ressources/Clients/getObtenir le résumé du client

Obtenir le résumé du client

Renvoie un instantané consolidé pour un client : statistiques agrégées d'emplacements, d'avis et de référencement SEO.

get/api/v1/clients/summary

clients:read

Paramètres de requête

clientIdstringobligatoire

Le client à résumer.

Réponse

dataobjectfacultatif

locationsobjectfacultatif

Statistiques agrégées d'emplacements pour ce client.

reviewsobjectfacultatif

Statistiques agrégées d'avis pour ce client.

seoobjectfacultatif

Statistiques agrégées de référencement SEO pour ce client.

Erreurs

400Il manque un paramètre requis à la requête, ou elle est invalide.

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/clients/summary

Votre clé API

clientId *

{
  "data": {
    "locations": {
      "total": 1,
      "byStatus": {
        "approved": 1
      },
      "byVerification": {
        "unknown": 1
      }
    },
    "reviews": {
      "avgRating": 4.8,
      "total": 26
    },
    "seo": {
      "avgRank": 3.2,
      "top3Pct": 0.62
    }
  }
}