Synup
Créer une clé
v1Ressources/Espace de travail/getObtenir le résumé de l'espace de travail

Obtenir le résumé de l'espace de travail

Renvoie un instantané agrégé de toute votre agence : nombre total de clients, plus les statistiques consolidées d'emplacements, d'avis et de référencement SEO.

get/api/v1/workspace/summary
workspace:read
Réponse
dataobjectfacultatif
clientsnumberfacultatif
Nombre total de clients dans votre agence.
locationsobjectfacultatif
Statistiques agrégées d'emplacements sur l'ensemble des clients.
reviewsobjectfacultatif
Statistiques agrégées d'avis sur l'ensemble des clients.
seoobjectfacultatif
Statistiques agrégées de positionnement SEO sur l'ensemble des clients.
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/workspace/summary
Votre clé API
{
  "data": {
    "clients": 24,
    "locations": {
      "total": 31,
      "byStatus": {
        "approved": 27,
        "archival_pending": 2,
        "pending": 2
      },
      "byVerification": {
        "verified": 22,
        "unverified": 6,
        "unknown": 3
      }
    },
    "reviews": {
      "avgRating": 4.4,
      "total": 1280
    },
    "seo": {
      "avgRank": 5.1,
      "top3Pct": 38
    }
  }
}

Guides qui utilisent cet endpoint