Obter dados analíticos do Facebook para um local

Parâmetros

Caminho

Nome	Tipo	Obrigatório	Descrição
locationId	string	obrigatório	Location 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.

Query

Nome	Tipo	Obrigatório	Descrição	Padrão
fromDate	string	opcional	Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.	—
toDate	string	opcional	End of the range (YYYY-MM-DD).	—

Respostas

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.

Retorna dados diários de interação com a Página do Facebook de um local. Cada métrica é um array de pontos de série temporal com um startTime (o dia de agrupamento) e um value. Requer que a Página do Facebook do local esteja conectada.

Métricas disponíveis:

views: total de visualizações da Página
ctaAction: cliques no botão de chamada para ação da Página
directionsAction: solicitações de rotas pela Página
phoneAction: chamadas iniciadas pela Página
websiteAction: cliques que levam ao site a partir da Página

Ambas as formas de id funcionam no caminho

Assim como os outros endpoints de análise, facebook-analytics aceita o id Relay em Base64 (TG9jYXRpb246MTgwMDI4OQ==) ou o id numérico bruto (1800289), e ambos correspondem ao mesmo local. Prefira o id Relay, que é o retornado pelos endpoints de leitura. Um valor que não corresponda a nenhuma dessas formas resulta no retorno de {"data":{"facebookInsights":null},"errors":[...]} com o status 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"

Atribuir engajamento ao botão de CTA

Quando um local usa uma chamada para ação como "Reserve agora" ou "Ligue agora" em sua Página, ctaAction e phoneAction permitem que você quantifique quantos desses cliques o botão gerou durante o período de uma campanha. Observe que cada métrica retorna null (e não um array vazio) quando a Página não tem dados para o intervalo ou não está conectada; verifique se o valor é null antes de iterar. Combine esses dados com os dados analíticos do Google e do Bing para criar uma visualização única de desempenho em várias plataformas de publicação.