GET/api/v4/locations/{locationId}/reviews/settings

Lister les sources d’avis d’un établissement

Renvoie les sources d’avis configurées pour un seul établissement, avec leurs URL de connexion.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chemin

NomTypeObligatoireDescription
locationIdstringobligatoireLocation to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

Réponses

200Review-source sites and their configured URLs for the location.
Response
{  "data": {    "interactionsSetting": {      "siteSettings": [        { "name": "maps.google.com", "url": null },        { "name": "facebook.com", "url": null },        { "name": "yelp.com", "url": null }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Renvoie les paramètres des sources d’avis d’un établissement. Chaque entrée de siteSettings correspond à une plateforme prise en charge par l’abonnement du compte. Une valeur non nulle pour url signifie que cette plateforme est connectée et que Listings API récupère les avis à partir de cette URL ; null url (comme indiqué ci-dessus pour l’établissement en production Jenny Home, auquel aucune source tierce n’est encore rattachée) signifie que la plateforme est disponible, mais pas encore configurée.

Cas d’utilisation : trouver les sources pour lesquelles une URL est encore nécessaire

Récupérez cette liste et filtrez les entrées selon url: null pour dresser la liste des plateformes que le propriétaire d’un établissement doit encore connecter. Les sources d’avis sont rattachées automatiquement une fois les profils Google et Facebook de l’établissement connectés ; connectez ces comptes pour renseigner les URL manquantes :

JSON
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }

Après la modification, la même plateforme est renvoyée avec son champ url renseigné à la place de null.

Cas d’utilisation : auditer les sources connectées sur un ensemble d’établissements

Parcourez vos établissements (obtenus via Lister tous les établissements) et appelez cet endpoint pour chaque établissement afin de produire un rapport sur la couverture des sources d’avis. Comme chaque établissement nécessite une requête, respectez la limite de débit du compte, espacez les appels et, en cas de 429, réessayez après le délai indiqué par l’en-tête Retry-After plutôt que de multiplier les requêtes.

Google et Facebook connectés via OAuth apparaissent automatiquement comme connectés et ne peuvent pas être remplacés via l’endpoint de modification. Utilisez Lister les sources d’avis d’un compte, dont la portée couvre l’ensemble du compte, pour voir toutes les plateformes que l’abonnement pourrait prendre en charge.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \  -H "Authorization: API $LISTINGSAPI_KEY"