GET/api/v4/locations/{locationId}/facebook-analytics

Obtenir les données analytiques Facebook d'un établissement

Renvoie les métriques quotidiennes d'interaction avec la Page Facebook d'un établissement sur une plage de dates.

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 ID, either the Base64 Relay id (e.g. TG9jYXRpb246MTgwMDI4OQ==) or the raw numeric database id (e.g. 1800289). Both forms resolve to the same location.

Chaîne de requête

NomTypeObligatoireDescriptionPar défaut
fromDatestringfacultatifStart of the range (YYYY-MM-DD). Defaults to a recent window when omitted.—
toDatestringfacultatifEnd of the range (YYYY-MM-DD).—

Réponses

200Daily Facebook Page interaction metrics. Each metric is a time-series array; a metric is `null` when no data exists for the range or the Page is not connected.
Response
{  "data": {    "facebookInsights": {      "views": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 120 }      ],      "ctaAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 5 }      ],      "directionsAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 3 }      ],      "phoneAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 2 }      ],      "websiteAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 9 }      ]    }  }}
401Unauthenticated, missing or invalid API key.

Renvoie les données quotidiennes d'interaction avec la Page Facebook d'un établissement. Chaque métrique est un tableau de points de série temporelle comportant un startTime (le jour de regroupement) et une value. La Page Facebook de l'établissement doit être connectée.

Métriques disponibles :

  • views : nombre total de vues de la Page
  • ctaAction : clics sur le bouton d'appel à l'action de la Page
  • directionsAction : demandes d'itinéraire via la Page
  • phoneAction : appels lancés depuis la Page
  • websiteAction : clics vers le site web depuis la Page

Les deux formes d'id fonctionnent dans le chemin

Comme les autres endpoints d'analyse, facebook-analytics accepte l'id Relay en Base64 (TG9jYXRpb246MTgwMDI4OQ==) ou l'id numérique brut (1800289), et les deux désignent le même établissement. Privilégiez l'id Relay, qui est celui que renvoient les endpoints de lecture. Une valeur qui ne correspond à aucune de ces deux formes entraîne le renvoi de {"data":{"facebookInsights":null},"errors":[...]} avec un statut 200.

Shell
curl -s 'https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/facebook-analytics?fromDate=2025-06-01&toDate=2025-06-30' \  -H "Authorization: API $LISTINGSAPI_KEY"

Attribuer l'engagement au bouton d'appel à l'action

Lorsqu'un établissement utilise un appel à l'action « Réserver maintenant » ou « Appeler maintenant » sur sa Page, ctaAction et phoneAction vous permettent de quantifier le nombre de ces clics générés par le bouton pendant la période d'une campagne. Notez que chaque métrique renvoie null (et non un tableau vide) lorsque la Page ne dispose d'aucune donnée pour la plage de dates ou n'est pas connectée ; vérifiez la présence de null avant de parcourir les données. Combinez ces données avec les données analytiques Google et Bing pour créer une vue unique des performances sur plusieurs plateformes de publication.

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