v1Ressources/Clients

Clients

Créez, consultez, mettez à jour et archivez les clients (entreprises) de votre agence.

Renvoie une page des clients de votre agence, les plus récents en premier. Tous les filtres sont facultatifs et se combinent (un client doit correspondre à tous); pour parcourir plus de résultats, renvoyez le nextCursor reçu.

Lister / rechercher des clients

get/api/v1/clients

clients:read

Paramètres de requête

searchstringfacultatif

Recherche libre sur le nom commercial, le secteur ou l'e-mail du contact principal du client (insensible à la casse, correspondances partielles autorisées).

statusarray of string (complete | draft)facultatif

Restreindre à un ou plusieurs statuts : complete (actif, intégration terminée) ou draft (encore en configuration).

representativeIdsarray of stringfacultatif

Restreindre aux clients assignés à un ou plusieurs de ces identifiants de membres d'équipe — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.

goalsarray of string (improve_rankings | get_reviews | fix_listings)facultatif

Restreindre à un ou plusieurs objectifs principaux du client : improve_rankings, get_reviews ou fix_listings.

healthMinnumberfacultatif

Score de santé minimum à inclure, 0–100.

healthMaxnumberfacultatif

Score de santé maximum à inclure, 0–100.

locationsMinnumberfacultatif

Nombre minimum d'établissements qu'un client doit avoir pour être inclus.

locationsMaxnumberfacultatif

Nombre maximum d'établissements qu'un client peut avoir tout en étant inclus.

createdAfterstringfacultatif

Uniquement les clients créés à cette date ou après.

createdBeforestringfacultatif

Uniquement les clients créés à cette date ou avant.

cursorstringfacultatif

Curseur de pagination provenant du nextCursor d'une réponse précédente. Laisser vide pour la première page.

limitintegerfacultatif

Nombre de clients à renvoyer par page, 1–200. La valeur par défaut est 50.

Réponse

dataobjectfacultatif

clientsarray of objectfacultatif

Les clients correspondant à cette page.

idstringfacultatif

Identifiant unique du client.

businessNamestringfacultatif

Le nom commercial du client.

industrystringfacultatif

Le secteur d'activité du client.

statusstring (complete | draft)facultatif

Statut d'intégration : complete (actif) ou draft.

goalstring (improve_rankings | get_reviews | fix_listings)facultatif

L'objectif principal du client, ou null.

healthScorenumberfacultatif

Un score de 0 à 100 résumant la santé du compte du client, ou null si non encore calculé.

locationCountnumberfacultatif

Nombre d'établissements de ce client, ou null si inconnu.

googleRatingnumberfacultatif

La note Google actuelle du client, ou null.

googleReviewCountnumberfacultatif

Le nombre actuel d'avis Google du client, ou null.

planNamestringfacultatif

Nom du plan de ce client, le cas échéant.

createdAtstringfacultatif

Date de création du client, au format horodatage ISO 8601.

archivedbooleanfacultatif

Si le client est archivé.

archivedAtstringfacultatif

Date d'archivage du client, au format horodatage ISO 8601, ou null.

scheduledArchiveAtstringfacultatif

Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.

primaryRepresentativeobjectfacultatif

Le membre de l'équipe responsable de ce client, ou null.

idstringfacultatif

firstNamestringfacultatif

lastNamestringfacultatif

emailstringfacultatif

nextCursorstringfacultatif

Curseur de pagination pour la page suivante, ou null lorsqu'il n'y a plus de résultats.

totalnumberfacultatif

Nombre total de clients correspondant aux filtres, sur toutes les pages.

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

Votre clé API

search

status

representativeIds

goals

healthMin

healthMax

locationsMin

locationsMax

createdAfter

createdBefore

cursor

limit

{
  "data": {
    "clients": [
      {
        "id": "cli_123",
        "businessName": "Acme Dental",
        "industry": "Dental",
        "status": "complete",
        "goal": "get_reviews",
        "healthScore": 82,
        "locationCount": 1,
        "googleRating": 4.8,
        "googleReviewCount": 26,
        "archived": false,
        "archivedAt": null,
        "scheduledArchiveAt": null,
        "packageType": null,
        "planName": null,
        "createdAt": "2026-01-15T10:00:00.000Z",
        "primaryRepresentative": {
          "id": "usr_123",
          "firstName": "Jamie",
          "lastName": "Lee",
          "email": "jamie@youragency.com"
        }
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}

v1Ressources/Clients/postCréer un client

Crée un nouveau client dans votre agence, ainsi qu'un premier établissement lorsque les coordonnées correspondent à un lieu réel.

Créer un client

post/api/v1/clients

clients:write

Corps de la requête

businessNamestringobligatoire

Le nom commercial du nouveau client.

primaryContactEmailstringobligatoire

Adresse e-mail du contact principal du client.

primaryRepresentativeIdstringobligatoire

ID du membre de l'équipe responsable de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.

websitestringfacultatif

L'URL du site web du client.

industrystringfacultatif

Le secteur d'activité du client.

goalstring (improve_rankings | get_reviews | fix_listings)facultatif

L'objectif principal du client : improve_rankings, get_reviews ou fix_listings.

gbpLinkstringfacultatif

L'URL du profil d'établissement Google du client.

placeIdstringfacultatif

L'identifiant de lieu Google du client, provenant de l'API Places de Google — Synup ne propose pas de recherche de lieux propre. Crée également le premier établissement du client — n'effectuez pas ensuite une création d'établissement distincte pour la même entreprise.

latitudenumberfacultatif

La latitude de l'établissement du client. Requise avec placeId et longitude pour suivre aussi un mot-clé.

longitudenumberfacultatif

La longitude de l'établissement du client.

googleRatingnumberfacultatif

La note Google actuelle du client, si connue.

googleReviewCountnumberfacultatif

Le nombre actuel d'avis Google du client, si connu.

trackingKeywordstringfacultatif

Un mot-clé pour suivre le classement local du client. Nécessite que placeId, latitude et longitude soient également définis.

clientPlanIdstringfacultatif

Quel plan de portail client assigner. Par défaut, le plan par défaut de votre agence. Il n'existe aucun endpoint listant les plans — récupérez un identifiant valide depuis le clientPlan.id d'un client existant, ou depuis les paramètres de plan de votre agence dans Synup.

notesstringfacultatif

Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.

Réponse

dataobjectfacultatif

clientobjectfacultatif

Des champs internes supplémentaires peuvent être présents mais ne font pas partie du contrat stable — ne vous fiez qu'aux champs documentés ici.

idstringfacultatif

Identifiant unique du client.

businessNamestringfacultatif

Le nom commercial du client.

websitestringfacultatif

L'URL du site web du client.

industrystringfacultatif

Le secteur d'activité du client.

primaryContactEmailstringfacultatif

Adresse e-mail du contact principal du client.

primaryRepresentativeIdstringfacultatif

ID du membre de l'équipe responsable de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.

visibilitystring (public | private)facultatif

Si le client est public ou private au sein de votre agence.

goalstring (improve_rankings | get_reviews | fix_listings)facultatif

L'objectif principal du client, ou null.

notesstringfacultatif

Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.

gbpLinkstringfacultatif

L'URL du profil d'établissement Google du client, ou null.

trackingKeywordstringfacultatif

Un mot-clé suivi pour le classement local de ce client, ou null.

healthScorenumberfacultatif

Un score de 0 à 100 résumant la santé du compte du client, ou null si non encore calculé.

planNamestringfacultatif

Nom du plan de ce client, le cas échéant.

archivedbooleanfacultatif

Si le client est archivé.

archivedAtstringfacultatif

Date d'archivage du client, au format horodatage ISO 8601, ou null.

scheduledArchiveAtstringfacultatif

Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.

createdAtstringfacultatif

Date de création du client, au format horodatage ISO 8601.

updatedAtstringfacultatif

Date de la dernière mise à jour du client, au format horodatage ISO 8601.

locationIdstringfacultatif

ID du premier établissement créé avec ce client, ou null si aucun n'a encore pu être créé.

locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)facultatif

Pourquoi aucun premier établissement n'a été créé, lorsqu'un placeId a été fourni mais qu'aucun établissement n'en a résulté — par exemple, location_limit signifie que l'agence a atteint la limite d'établissements de son plan. Null si non applicable.

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.

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

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

post/api/v1/clients

Votre clé API

Corps de la requête*

{
  "data": {
    "client": {
      "id": "cli_123",
      "businessName": "Acme Dental",
      "website": null,
      "industry": null,
      "primaryContactEmail": "owner@acmedental.com",
      "primaryRepresentativeId": "usr_123",
      "visibility": "public",
      "goal": null,
      "notes": null,
      "gbpLink": null,
      "trackingKeyword": null,
      "healthScore": null,
      "planName": null,
      "archived": false,
      "archivedAt": null,
      "scheduledArchiveAt": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    "locationId": "loc_456",
    "locationSkipped": null
  }
}

v1Ressources/Clients/getObtenir un client

Renvoie tous les détails d'un client : profil de l'entreprise, représentant assigné, créateur, score de santé et plan.

Obtenir un client

get/api/v1/clients/{id}

clients:read

Paramètres de requête

idstringobligatoire

Le client à consulter.

Réponse

dataobjectfacultatif

Tout ce qui figure dans Client, plus les objets résolus du représentant, du créateur et du plan.

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.

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/clients/{id}

Votre clé API

id *

{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z",
    "primaryRepresentative": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "createdBy": {
      "id": "usr_123",
      "firstName": "Jamie",
      "lastName": "Lee",
      "email": "jamie@youragency.com"
    },
    "clientPlan": null
  }
}

v1Ressources/Clients/patchMettre à jour un client

Modifie les champs modifiables d'un client existant. Envoyez uniquement les champs que vous souhaitez changer. Le primaryContactEmail du client (son identifiant de connexion au portail) ne peut être défini ici que tant qu'il est encore vide — il ne peut plus jamais être modifié une fois défini.

Mettre à jour un client

patch/api/v1/clients/{id}

clients:write

Paramètres de requête

idstringobligatoire

Le client à mettre à jour.

Corps de la requête

businessNamestringfacultatif

Le nom commercial du nouveau client.

industrystringfacultatif

Le secteur d'activité du client.

websitestringfacultatif

L'URL du site web du client.

primaryContactNamestringfacultatif

Le nom du contact principal.

phonestringfacultatif

Le numéro de téléphone du client.

locationCountnumberfacultatif

Le nombre d'établissements déclaré par le client — à titre informatif uniquement, pas le nombre réel d'établissements créés.

citystringfacultatif

La ville du client.

phoneCountryCodestringfacultatif

Le pays au format ISO-3166-1 alpha-2 auquel appartient le numéro de téléphone du client (par ex. « US », « IN ») — la région, pas l'indicatif téléphonique.

countrystringfacultatif

Le pays du client, au format code ISO-3166-1 alpha-2.

statestringfacultatif

L'État, la province ou la région du client.

trackingKeywordstringfacultatif

Un mot-clé pour suivre le classement local du client.

notesstringfacultatif

Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.

gbpLinkstringfacultatif

L'URL du profil d'établissement Google du client.

packageTypestringfacultatif

Le type de forfait du client.

clientPlanIdstringfacultatif

Quel plan de portail client assigner. Par défaut, le plan par défaut de votre agence. Il n'existe aucun endpoint listant les plans — récupérez un identifiant valide depuis le clientPlan.id d'un client existant, ou depuis les paramètres de plan de votre agence dans Synup.

primaryRepresentativeIdstringfacultatif

L'ID utilisateur du membre de l'équipe propriétaire de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.

visibilitystring (public | private)facultatif

Si le client est public ou private au sein de votre agence.

primaryContactEmailstringfacultatif

Adresse e-mail du contact principal du client. Modifiable uniquement tant qu'elle est vide — elle devient l'identifiant de connexion au portail et ne peut plus jamais être modifiée une fois définie.

Réponse

dataobjectfacultatif

Des champs internes supplémentaires peuvent être présents mais ne font pas partie du contrat stable — ne vous fiez qu'aux champs documentés ici.

idstringfacultatif

Identifiant unique du client.

businessNamestringfacultatif

Le nom commercial du client.

websitestringfacultatif

L'URL du site web du client.

industrystringfacultatif

Le secteur d'activité du client.

primaryContactEmailstringfacultatif

Adresse e-mail du contact principal du client.

primaryRepresentativeIdstringfacultatif

ID du membre de l'équipe responsable de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.

visibilitystring (public | private)facultatif

Si le client est public ou private au sein de votre agence.

goalstring (improve_rankings | get_reviews | fix_listings)facultatif

L'objectif principal du client, ou null.

notesstringfacultatif

Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.

gbpLinkstringfacultatif

L'URL du profil d'établissement Google du client, ou null.

trackingKeywordstringfacultatif

Un mot-clé suivi pour le classement local de ce client, ou null.

healthScorenumberfacultatif

Un score de 0 à 100 résumant la santé du compte du client, ou null si non encore calculé.

planNamestringfacultatif

Nom du plan de ce client, le cas échéant.

archivedbooleanfacultatif

Si le client est archivé.

archivedAtstringfacultatif

Date d'archivage du client, au format horodatage ISO 8601, ou null.

scheduledArchiveAtstringfacultatif

Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.

createdAtstringfacultatif

Date de création du client, au format horodatage ISO 8601.

updatedAtstringfacultatif

Date de la dernière mise à jour du client, au format horodatage ISO 8601.

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.

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

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

patch/api/v1/clients/{id}

Votre clé API

id *

Corps de la requête

{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T09:30:00.000Z"
  }
}

v1Ressources/Clients/deleteArchiver un client

Demande l'archivage d'un client — cette API ne le supprime jamais définitivement. Si le client possède des établissements, cela PLANIFIE l'opération : le client et tous ses établissements s'archivent à la fin de la période de facturation en cours, et jusque-là tout reste pleinement actif et facturé — l'archivage peut être annulé via l'endpoint cancel-archive. Un client sans aucun établissement est en revanche archivé immédiatement (il n'y a rien à différer). Le champ outcome de la réponse indique lequel des deux s'est réellement produit.

Archiver un client

delete/api/v1/clients/{id}

clients:write

Paramètres de requête

idstringobligatoire

Le client à archiver.

Réponse

dataobjectfacultatif

Les champs présents dépendent de outcome : scheduled contient scheduledArchiveAt/archiveAt/locationCount ; archived contient locationsArchived/locationsFailed/cancelledScheduledPosts.

outcomestring (scheduled | archived)obligatoire

Ce qui s'est réellement passé : archived (immédiat — aucun établissement n'existait, ou aucun n'était actif) ou scheduled (archivage à la fin de la période de facturation).

clientIdstringobligatoire

Identifiant unique du client.

businessNamestringobligatoire

Le nom commercial du client.

scheduledArchiveAtstringfacultatif

Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.

archiveAtstringfacultatif

Date à laquelle l'archivage planifié aura réellement lieu — la limite de facturation de l'agence. Null si l'agence n'en a aucune. Présent uniquement lorsque outcome est scheduled.

locationCountnumberfacultatif

Nombre d'établissements de ce client, ou null si inconnu.

locationsArchivednumberfacultatif

Nombre d'établissements archivés avec le client. Présent uniquement lorsque outcome est archived.

locationsFailednumberfacultatif

Nombre d'établissements dont l'archivage a échoué. Présent uniquement lorsque outcome est archived.

cancelledScheduledPostsnumberfacultatif

Nombre de publications planifiées annulées dans le cadre de l'archivage. Présent uniquement lorsque outcome est archived.

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.

404La ressource est introuvable, ou n'appartient pas à votre agence.

409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

delete/api/v1/clients/{id}

Votre clé API

id *

{
  "data": {
    "outcome": "scheduled",
    "clientId": "cli_123",
    "businessName": "Acme Dental",
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z",
    "locationCount": 1
  }
}

v1Ressources/Clients/postAnnuler un archivage planifié

Annule un archivage de client en attente, afin qu'un client planifié pour archivage à la fin de la période de facturation continue normalement. Libère également les établissements qui étaient planifiés avec lui. Ne fonctionne que tant que l'archivage est encore en attente — un client déjà entièrement archivé doit plutôt être réactivé, via l'endpoint reactivate.

Annuler un archivage planifié

post/api/v1/clients/{id}/cancel-archive

clients:write

Paramètres de requête

idstringobligatoire

Le client dont l'archivage en attente doit être annulé.

Réponse

dataobjectfacultatif

cancelledbooleanfacultatif

Toujours true en cas de succès.

locationsReleasednumberfacultatif

Nombre d'établissements libérés de la planification d'archivage annulée.

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.

404La ressource est introuvable, ou n'appartient pas à votre agence.

409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

post/api/v1/clients/{id}/cancel-archive

Votre clé API

id *

{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}

v1Ressources/Clients/postEnvoyer l'invitation au portail client

Envoie (ou renvoie) l'e-mail d'invitation au portail client au contact principal d'un client — un lien magique sans mot de passe. Le renvoyer invalide tout lien précédemment envoyé. Échoue si le client n'a pas de primaryContactEmail défini.

Envoyer l'invitation au portail client

post/api/v1/clients/{id}/invite

clients:write

Paramètres de requête

idstringobligatoire

Le client à inviter.

Réponse

dataobjectfacultatif

portalLinkstringfacultatif

L'URL du lien magique envoyé dans l'e-mail d'invitation.

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.

404La ressource est introuvable, ou n'appartient pas à votre agence.

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

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

post/api/v1/clients/{id}/invite

Votre clé API

id *

{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

v1Ressources/Clients/postRéactiver un client archivé

Restaure un client déjà archivé, ainsi que tous les établissements archivés avec lui. Un client qui n'est pas actuellement archivé se traduit par un succès sans effet, pas par une erreur. C'est le seul moyen de revenir en arrière pour un client dont outcome est archived — un client encore planifié doit plutôt passer par cancel-archive.

Réactiver un client archivé

post/api/v1/clients/{id}/reactivate

clients:write

Paramètres de requête

idstringobligatoire

Le client à réactiver.

Réponse

dataobjectfacultatif

archivedbooleanfacultatif

Si le client est archivé.

locationsArchivednumberfacultatif

Nombre d'établissements archivés avec le client. Présent uniquement lorsque outcome est archived.

locationsFailednumberfacultatif

Nombre d'établissements dont l'archivage a échoué. Présent uniquement lorsque outcome est archived.

cancelledScheduledPostsnumberfacultatif

Nombre de publications planifiées annulées dans le cadre de l'archivage. Présent uniquement lorsque outcome est archived.

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.

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.

post/api/v1/clients/{id}/reactivate

Votre clé API

id *

{
  "data": {
    "archived": false,
    "locationsArchived": 1,
    "locationsFailed": 0,
    "cancelledScheduledPosts": 0
  }
}

v1Ressources/Clients/getObtenir 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.

Obtenir le résumé du client

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
    }
  }
}