Synupv1
Criar chave
v1Recursos/Análise de perfil/getObter análises do perfil

Obter análises do perfil

Retorna métricas de visualizações/ações do perfil de um local em um período, agregadas por fonte conectada (Google, Facebook, Apple, Bing).

get/api/v1/analytics
analytics:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringobrigatório
O cliente do local.
fromstringopcional
Data de início (YYYY-MM-DD) do período. Opcional — o padrão é a janela padrão da fonte.
tostringopcional
Data de fim (YYYY-MM-DD) do período. Opcional.
Resposta
dataobjectopcional
connectedSourcesarray of string (google | facebook | apple | bing)opcional
Quais plataformas este local tem conectadas: google, facebook, apple, bing.
summarystringopcional
Um breve resumo legível do desempenho, ou null.
syncedAtstringopcional
Data da última sincronização destes dados, como timestamp ISO 8601, ou null.
latestDataDaystringopcional
Dia mais recente com dados, como YYYY-MM-DD, ou null.
profileViewsobjectopcional
Visualizações do perfil ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
allActionsobjectopcional
Todas as ações de clientes (ligações, pedidos de rota, visitas ao site, cliques em botões) combinadas, ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
websiteVisitsobjectopcional
Visitas ao site ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
phoneCallsobjectopcional
Ligações telefônicas ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
directionRequestsobjectopcional
Pedidos de rota ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
buttonClicksobjectopcional
Cliques em outros botões do perfil ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
followersobjectopcional
Seguidores no Facebook ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
postEngagementobjectopcional
Engajamento com publicações no Facebook ao longo do tempo.
metricstringopcional
Nome da métrica.
totalnumberopcional
Total do período selecionado, ou null.
previousTotalnumberopcional
Total do período comparável anterior, ou null.
labelsarray of stringopcional
Rótulos de data para cada ponto da série.
bySourceobjectopcional
Valores diários detalhados por fonte conectada.
searchKeywordsarray of objectopcional
Termos de busca que exibiram esta listagem, somente Google.
keywordstringopcional
O termo de busca.
impressionsnumberopcional
Número de impressões para esse termo.
keywordMonthsobjectopcional
Período coberto pelos termos de busca, ou null.
fromstringopcional
tostringopcional
impressionSplitobjectopcional
Divisão de impressões por superfície, somente Google, ou null.
mapsnumberopcional
Impressões no Google Maps.
searchnumberopcional
Impressões na Busca do Google.
desktopnumberopcional
Impressões em desktop.
mobilenumberopcional
Impressões em dispositivos móveis.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/analytics
Sua chave de 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
    }
  }
}