Synupv1
Créer une clé
v1Ressources/Statistiques de profil

Statistiques de profil

Consultez les statistiques de performance du profil d'un établissement.

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).

Obtenir les statistiques du profil

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
    }
  }
}
v1Ressources/Statistiques de profil/getObtenir un résumé des statistiques de profil

Statistiques de profil agrégées sur les emplacements d'un client — vues de profil, toutes actions, visites du site web, appels téléphoniques, demandes d'itinéraire, clics sur les boutons, abonnés et engagement des publications, ainsi qu'un classement par emplacement. Restreindre à un seul tag avec tagId, ou l'omettre pour tous les emplacements du client. Utilise le même rollup que la vue Fiches → Tous les emplacements → Statistiques de profil.

Obtenir un résumé des statistiques de profil

get/api/v1/analytics/summary
analytics:read
Paramètres de requête
clientIdstringobligatoire
Le client à agréger. Obligatoire.
tagIdstringfacultatif
Un ID de tag d'emplacement (depuis GET /api/v1/locations/tags avec withId=1) — restreint le rollup aux emplacements de ce tag. À omettre pour tous les emplacements du client.
fromstringfacultatif
Début de la fenêtre (date ISO). Par défaut, il y a 30 jours.
tostringfacultatif
Fin de la fenêtre (date ISO). Par défaut, maintenant.
sourcesstringfacultatif
Publishers à inclure, séparés par des virgules : google, facebook, apple, bing. Par défaut, tous.
comparisonstring (none | previous_period)facultatif
Comparer les totaux à une fenêtre précédente de même durée.
granularitystring (daily | weekly | monthly)facultatif
Intervalle de temps pour la série sous-jacente.
leaderboardLimitintegerfacultatif
Top N emplacements dans le classement (1-100). Par défaut 25.
leaderboardSearchstringfacultatif
Filtrer le classement par nom d'emplacement.
Réponse
dataobjectfacultatif
connectedSourcesarray of string (google | facebook | apple | bing)facultatif
Publishers connectés sur au moins un emplacement du périmètre.
locationsnumberfacultatif
Nombre d'emplacements dans le périmètre.
coverageobjectfacultatif
Combien d'emplacements du périmètre ont remonté des données sur la fenêtre.
withDatanumberfacultatif
Emplacements ayant remonté des données.
totalnumberfacultatif
Emplacements dans le périmètre.
summarystringfacultatif
Résumé IA au niveau du client — non renseigné pour ce rollup (toujours null).
syncedAtstringfacultatif
Date de la dernière exécution de l'agrégation sous-jacente.
latestDataDaystringfacultatif
Le jour le plus récent avec des données, sur tout le périmètre.
profileViewsobjectfacultatif
Vues de profil, cumulées sur le périmètre.
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, cumulées sur le périmètre.
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, cumulées sur le périmètre.
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, cumulés sur le périmètre.
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, cumulées sur le périmètre.
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 boutons, cumulés sur le périmètre.
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
Série de KPI d'abonnés, cumulée sur le périmètre.
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 des publications, cumulé sur le périmètre.
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
Toujours vide pour ce rollup — les données de mots-clés par emplacement sont sur GET /api/v1/analytics.
keywordstringfacultatif
impressionsnumberfacultatif
keywordMonthsobjectfacultatif
Toujours null pour ce rollup.
fromstringfacultatif
tostringfacultatif
followersTotalobjectfacultatif
Jauge d'abonnés Facebook, à la fin de la fenêtre.
totalnumberfacultatif
Nombre d'abonnés actuel.
previousTotalnumberfacultatif
Nombre d'abonnés à la fin de la fenêtre précédente (si une comparaison est demandée).
locationsnumberfacultatif
Emplacements contribuant à la jauge.
leaderboardobjectfacultatif
Classement par emplacement selon les vues de profil.
rowsarray of objectfacultatif
Une ligne par emplacement, classée par vues de profil.
locationIdstringfacultatif
ID de l'emplacement.
namestringfacultatif
Nom de l'emplacement.
citystringfacultatif
Ville de l'emplacement.
profileViewsnumberfacultatif
Vues de profil pour cet emplacement.
allActionsnumberfacultatif
Toutes les actions pour cet emplacement.
phoneCallsnumberfacultatif
Appels téléphoniques pour cet emplacement.
directionRequestsnumberfacultatif
Demandes d'itinéraire pour cet emplacement.
deltaPctnumberfacultatif
Évolution par rapport à la fenêtre précédente, sur les vues de profil.
sparkarray of numberfacultatif
Vues de profil par période sur la fenêtre, pour une sparkline.
totalnumberfacultatif
Total des emplacements correspondants (pour la pagination).
pagenumberfacultatif
Page actuelle du classement (base 0).
pageSizenumberfacultatif
Taille de page du classement.
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/summary
Votre clé API
clientId *
tagId
from
to
sources
comparison
granularity
leaderboardLimit
leaderboardSearch
{
  "data": {
    "connectedSources": [
      "google",
      "facebook"
    ],
    "summary": null,
    "syncedAt": "2026-02-01T00:00:00.000Z",
    "latestDataDay": "2026-01-31",
    "profileViews": {
      "metric": "Profile Views",
      "total": 4800,
      "previousTotal": 4300,
      "labels": [
        "2026-01-01",
        "2026-01-31"
      ],
      "bySource": {
        "google": [
          160,
          168
        ]
      }
    },
    "allActions": {
      "metric": "All Actions",
      "total": 1100,
      "previousTotal": 980,
      "labels": [],
      "bySource": {}
    },
    "websiteVisits": {
      "metric": "Website Visits",
      "total": 600,
      "previousTotal": 540,
      "labels": [],
      "bySource": {}
    },
    "phoneCalls": {
      "metric": "Phone Calls",
      "total": 210,
      "previousTotal": 195,
      "labels": [],
      "bySource": {}
    },
    "directionRequests": {
      "metric": "Direction Requests",
      "total": 340,
      "previousTotal": 300,
      "labels": [],
      "bySource": {}
    },
    "buttonClicks": {
      "metric": "Button Clicks",
      "total": 80,
      "previousTotal": 70,
      "labels": [],
      "bySource": {}
    },
    "followers": {
      "metric": "Followers",
      "total": null,
      "previousTotal": null,
      "labels": [],
      "bySource": {}
    },
    "postEngagement": {
      "metric": "Post Engagement",
      "total": null,
      "previousTotal": null,
      "labels": [],
      "bySource": {}
    },
    "searchKeywords": [],
    "keywordMonths": null,
    "impressionSplit": {
      "maps": 0,
      "search": 0,
      "desktop": 0,
      "mobile": 0
    },
    "followersTotal": {
      "total": 812,
      "previousTotal": 790,
      "locations": 4
    },
    "coverage": {
      "withData": 4,
      "total": 5
    },
    "locations": 5,
    "leaderboard": {
      "rows": [
        {
          "locationId": "cl_a1b2c3",
          "synupLocationId": "os_9f8e7d6c",
          "name": "Acme Dental — Downtown",
          "city": "Austin",
          "profileViews": 1900,
          "allActions": 420,
          "phoneCalls": 90,
          "directionRequests": 140,
          "deltaPct": 0.12,
          "spark": [
            58,
            61,
            64,
            60,
            66
          ]
        }
      ],
      "total": 5,
      "page": 0,
      "pageSize": 25
    }
  }
}