Synup
Créer une clé
v1Ressources/Reviews/getLister les concurrents suivis

Lister les concurrents suivis

Les concurrents suivis pour un emplacement, ou — avec clientId sans locationId — l'ensemble consolidé au niveau du client, affiché sur tous ses emplacements.

get/api/v1/reviews/competitors
reviews:read
Paramètres de requête
locationIdstringfacultatif
L'emplacement à consulter. Omettre pour lister à la place l'ensemble consolidé au niveau du client — transmettre clientId dans ce cas.
clientIdstringfacultatif
Le client de l'emplacement. Obligatoire avec locationId ; seul, il liste l'ensemble consolidé au niveau du client.
Réponse
dataobjectfacultatif
competitorsarray of objectfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/competitors
Votre clé API
locationId
clientId
{
  "data": {
    "competitors": [
      {
        "id": "cm_comp_1",
        "kind": "competitor",
        "source": "manual",
        "name": "Smile Bright Dental",
        "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
        "address": "45 Congress Ave, Austin, TX",
        "lastUpdated": "2026-02-01T06:00:00.000Z",
        "avgRating": 4.6,
        "reviewCount": 340
      }
    ]
  }
}

Guides qui utilisent cette ressource