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

Obter dados analíticos do Google para um local

Retorna métricas diárias de interação do Google Business Profile para um local em um intervalo de datas.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
locationIdstringobrigatórioLocation 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

NomeTipoObrigatórioDescriçãoPadrão
fromDatestringopcionalStart of the range (YYYY-MM-DD). Defaults to a recent window when omitted.—
toDatestringopcionalEnd of the range (YYYY-MM-DD).—

Respostas

200Daily Google interaction metrics. Each metric is a time-series array; a metric is `null` when no data exists for the range or the profile is not connected.
Response
{  "data": {    "googleInsights": {      "total": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 412 },        { "startTime": "2025-06-02T00:00:00+00:00", "value": 388 }      ],      "search": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 300 }      ],      "maps": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 112 }      ],      "directionsAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 24 }      ],      "phoneAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 8 }      ],      "websiteAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 41 }      ],      "businessBookings": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 0 }      ],      "businessFoodOrders": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 0 }      ],      "businessFoodMenuClicks": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 0 }      ]    }  }}
401Unauthenticated, missing or invalid API key.

Retorna dados diários de interação do Google Business Profile para um local. Cada métrica é um array de pontos de uma série temporal, em que cada ponto tem um startTime (o dia ao qual a contagem é atribuída) e um value.

Métricas disponíveis:

  • total: total de impressões do perfil, search mais maps. Esse total não inclui as métricas de ação abaixo, portanto, no exemplo acima, 412 = 300 na pesquisa + 112 nos mapas.
  • search: impressões nos resultados do Google Search (computadores e dispositivos móveis combinados)
  • maps: impressões nos resultados do Google Maps (computadores e dispositivos móveis combinados)
  • directionsAction: solicitações de rotas até o local
  • phoneAction: cliques no botão de chamada
  • websiteAction: cliques que levam ao site
  • businessBookings: reservas iniciadas a partir do perfil
  • businessFoodOrders: pedidos de comida feitos a partir do perfil
  • businessFoodMenuClicks: cliques no link do cardápio

Qualquer um dos formatos de id funciona no caminho

Tanto 1800289 quanto TG9jYXRpb246MTgwMDI4OQ== identificam o mesmo local. Prefira o id Relay em Base64: é o que todos os endpoints de leitura retornam e é o formato aceito pelo restante da API. Um valor que não seja um número nem um id Relay decodificável resulta em uma resposta 200 cujo corpo é {"data":{"googleInsights":null},"errors":[...]}, o que pode ser facilmente confundido com uma falha do servidor.

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

Relatar o impacto de uma atualização de dados

Um uso comum é um relatório de visibilidade antes e depois: após enviar alterações de horários ou categorias para um local, consulte google-analytics periodicamente para as semanas anteriores e posteriores à alteração e crie um gráfico de search + maps para mostrar o aumento. As métricas individuais retornam null (em vez de um array vazio) quando o local não tem dados do Google para o período solicitado ou quando seu perfil do Google não está conectado; trate null e [] da mesma forma na sua agregação. Combine com os dados analíticos do Facebook e do Bing para obter uma visão que abranja várias plataformas de publicação.

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