Synupv1
Criar chave
v1Recursos/Análise de perfil

Análise de perfil

Consulte as análises de desempenho do perfil de um local.

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

Obter análises do perfil

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
    }
  }
}
v1Recursos/Análise de perfil/getObter um resumo de análise de perfil

Análise de perfil agregada nos locais de um cliente — visualizações de perfil, todas as ações, visitas ao site, ligações telefônicas, pedidos de rota, cliques em botões, seguidores e engajamento de publicações, além de um ranking por local. Limite a uma única tag com tagId, ou omita para todos os locais do cliente. Usa o mesmo rollup da visualização Listagens → Todos os locais → Análise de perfil.

Obter um resumo de análise de perfil

get/api/v1/analytics/summary
analytics:read
Parâmetros de consulta
clientIdstringobrigatório
O cliente a agregar. Obrigatório.
tagIdstringopcional
Um ID de tag de local (de GET /api/v1/locations/tags com withId=1) — limita o rollup aos locais dessa tag. Omita para todos os locais do cliente.
fromstringopcional
Início da janela (data ISO). Padrão: 30 dias atrás.
tostringopcional
Fim da janela (data ISO). Padrão: agora.
sourcesstringopcional
Publishers a incluir, separados por vírgula: google, facebook, apple, bing. Padrão: todos.
comparisonstring (none | previous_period)opcional
Comparar os totais com uma janela anterior de mesma duração.
granularitystring (daily | weekly | monthly)opcional
Intervalo de tempo para a série subjacente.
leaderboardLimitintegeropcional
Top-N locais no ranking (1-100). Padrão 25.
leaderboardSearchstringopcional
Filtrar o ranking por nome do local.
Resposta
dataobjectopcional
connectedSourcesarray of string (google | facebook | apple | bing)opcional
Publishers conectados em pelo menos um local do escopo.
locationsnumberopcional
Número de locais no escopo.
coverageobjectopcional
Quantos dos locais no escopo reportaram algum dado na janela.
withDatanumberopcional
Locais que reportaram dados.
totalnumberopcional
Locais no escopo.
summarystringopcional
Resumo de IA em nível de cliente — não preenchido neste rollup (sempre null).
syncedAtstringopcional
Quando a agregação subjacente rodou pela última vez.
latestDataDaystringopcional
O dia mais recente com dados, em todo o escopo.
profileViewsobjectopcional
Visualizações de perfil, somadas no escopo.
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, somadas no escopo.
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, somadas no escopo.
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, somadas no escopo.
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, somados no escopo.
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 botões, somados no escopo.
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
Série de KPI de seguidores, somada no escopo.
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 de publicações, somado no escopo.
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
Sempre vazio neste rollup — dados de palavras-chave por local estão em GET /api/v1/analytics.
keywordstringopcional
impressionsnumberopcional
keywordMonthsobjectopcional
Sempre null neste rollup.
fromstringopcional
tostringopcional
followersTotalobjectopcional
Medidor de seguidores do Facebook, no fim da janela.
totalnumberopcional
Número atual de seguidores.
previousTotalnumberopcional
Número de seguidores no fim da janela anterior (quando a comparação é solicitada).
locationsnumberopcional
Locais que contribuem para o medidor.
leaderboardobjectopcional
Ranking por local segundo visualizações de perfil.
rowsarray of objectopcional
Uma linha por local, classificada por visualizações de perfil.
locationIdstringopcional
ID do local.
namestringopcional
Nome do local.
citystringopcional
Cidade do local.
profileViewsnumberopcional
Visualizações de perfil deste local.
allActionsnumberopcional
Todas as ações deste local.
phoneCallsnumberopcional
Ligações telefônicas deste local.
directionRequestsnumberopcional
Pedidos de rota deste local.
deltaPctnumberopcional
Variação em relação à janela anterior, em visualizações de perfil.
sparkarray of numberopcional
Visualizações de perfil por período ao longo da janela, para um sparkline.
totalnumberopcional
Total de locais correspondentes (para paginação).
pagenumberopcional
Página atual do ranking (base 0).
pageSizenumberopcional
Tamanho de página do ranking.
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/summary
Sua chave de 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
    }
  }
}