Synupv1
Créer une clé
v1Ressources/Statistiques de profil/getObtenir les statistiques du profil

Obtenir les statistiques du profil

Renvoie les indicateurs de vues/actions du profil d'un établissement sur une période, agrégés par source connectée (Google, Facebook, Apple, Bing).

get/api/v1/analytics
analytics:read
Paramètres de requête
locationIdstringobligatoire
L'établissement à consulter.
clientIdstringobligatoire
Le client de l'établissement.
fromstringfacultatif
Date de début (YYYY-MM-DD) de la période. Facultatif — par défaut, la fenêtre standard de la source est utilisée.
tostringfacultatif
Date de fin (YYYY-MM-DD) de la période. Facultatif.
Réponse
dataobjectfacultatif
connectedSourcesarray of string (google | facebook | apple | bing)facultatif
Les plateformes connectées à cet établissement : google, facebook, apple, bing.
summarystringfacultatif
Un court résumé lisible de la performance, ou null.
syncedAtstringfacultatif
Date de la dernière synchronisation de ces données, au format horodatage ISO 8601, ou null.
latestDataDaystringfacultatif
Jour le plus récent disposant de données, au format YYYY-MM-DD, ou null.
profileViewsobjectfacultatif
Nombre de vues du profil dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
allActionsobjectfacultatif
Toutes les actions clients (appels, demandes d'itinéraire, visites du site web, clics sur les boutons) combinées, dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
websiteVisitsobjectfacultatif
Visites du site web dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
phoneCallsobjectfacultatif
Appels téléphoniques dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
directionRequestsobjectfacultatif
Demandes d'itinéraire dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
buttonClicksobjectfacultatif
Clics sur les autres boutons du profil dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
followersobjectfacultatif
Abonnés Facebook dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
postEngagementobjectfacultatif
Engagement sur les publications Facebook dans le temps.
metricstringfacultatif
Nom de l'indicateur.
totalnumberfacultatif
Total pour la période sélectionnée, ou null.
previousTotalnumberfacultatif
Total pour la période comparable précédente, ou null.
labelsarray of stringfacultatif
Étiquettes de date pour chaque point de la série.
bySourceobjectfacultatif
Valeurs quotidiennes ventilées par source connectée.
searchKeywordsarray of objectfacultatif
Termes de recherche ayant fait apparaître cette fiche, Google uniquement.
keywordstringfacultatif
Le terme de recherche.
impressionsnumberfacultatif
Nombre d'impressions pour ce terme.
keywordMonthsobjectfacultatif
Période couverte par les termes de recherche, ou null.
fromstringfacultatif
tostringfacultatif
impressionSplitobjectfacultatif
Répartition des impressions par support, Google uniquement, ou null.
mapsnumberfacultatif
Impressions sur Google Maps.
searchnumberfacultatif
Impressions sur la Recherche Google.
desktopnumberfacultatif
Impressions sur ordinateur.
mobilenumberfacultatif
Impressions sur mobile.
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/analytics
Votre clé API
locationId *
clientId *
from
to
{
  "data": {
    "connectedSources": [
      "google"
    ],
    "summary": "Profile views are up 12% this month.",
    "syncedAt": "2026-02-01T00:00:00.000Z",
    "latestDataDay": "2026-01-31",
    "profileViews": {
      "metric": "Profile Views",
      "total": 1200,
      "previousTotal": 1050,
      "labels": [
        "2026-01-01",
        "2026-01-31"
      ],
      "bySource": {
        "google": [
          40,
          42
        ]
      }
    },
    "allActions": {
      "metric": "All Actions",
      "total": 300,
      "previousTotal": 280,
      "labels": [],
      "bySource": {}
    },
    "websiteVisits": {
      "metric": "Website Visits",
      "total": 150,
      "previousTotal": 140,
      "labels": [],
      "bySource": {}
    },
    "phoneCalls": {
      "metric": "Phone Calls",
      "total": 60,
      "previousTotal": 55,
      "labels": [],
      "bySource": {}
    },
    "directionRequests": {
      "metric": "Direction Requests",
      "total": 90,
      "previousTotal": 85,
      "labels": [],
      "bySource": {}
    },
    "buttonClicks": {
      "metric": "Button Clicks",
      "total": 20,
      "previousTotal": 18,
      "labels": [],
      "bySource": {}
    },
    "followers": {
      "metric": "Followers",
      "total": null,
      "previousTotal": null,
      "labels": [],
      "bySource": {}
    },
    "postEngagement": {
      "metric": "Post Engagement",
      "total": null,
      "previousTotal": null,
      "labels": [],
      "bySource": {}
    },
    "searchKeywords": [
      {
        "keyword": "dentist near me",
        "impressions": 320
      }
    ],
    "keywordMonths": {
      "from": "2026-01-01",
      "to": "2026-01-31"
    },
    "impressionSplit": {
      "maps": 600,
      "search": 900,
      "desktop": 500,
      "mobile": 1000
    }
  }
}