Synup
Criar chave
v1Recursos/SEO/getObter a visão geral de classificação de um local

Obter a visão geral de classificação de um local

Retorna as palavras-chave monitoradas, a tendência mensal de classificação, a grade de classificação e cartões de estatísticas para um local. Passe keywordId para restringir a grade a uma única palavra-chave, ou month (YYYY-MM) para fixá-la em um mês específico em vez do relatório mais recente medido de cada palavra-chave.

get/api/v1/seo/keywords
seo:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringopcional
O cliente do local.
keywordIdstringopcional
Restringe a grade a uma palavra-chave monitorada. Omita para a grade agregada de melhor classificação por célula entre todas as palavras-chave ativas.
monthstringopcional
Fixa a grade e as estatísticas neste mês (YYYY-MM) em vez do relatório mais recente medido de cada palavra-chave.
Resposta
dataobjectopcional
Podem existir campos internos adicionais que não fazem parte do contrato estável — baseie-se apenas nos campos documentados aqui.
keywordsarray of objectopcional
Palavras-chave monitoradas para este local, cada uma com sua classificação atual e tendência mensal.
idstringopcional
Identificador único da palavra-chave monitorada.
keywordstringopcional
O texto da palavra-chave.
avgRanknumberopcional
A classificação média mais recente medida da palavra-chave em toda a grade (menor é melhor; null se nunca medida ou sem classificação).
monthlyarray of objectopcional
A classificação média desta palavra-chave para cada mês em que há um relatório.
monthstringopcional
ranknumberopcional
monthsarray of objectopcional
Todo mês com pelo menos um relatório medido, do mais antigo ao mais recente, com a classificação média nas palavras-chave para esse mês.
keystringopcional
Mês no formato YYYY-MM.
labelstringopcional
Rótulo legível para o mês, ex.: "Aug 2026".
avgRanknumberopcional
Classificação média entre as palavras-chave monitoradas para este mês, ou null.
gridarray of objectopcional
A grade de classificação: uma entrada por ponto extraído, combinada entre as palavras-chave/mês em escopo.
idstringopcional
rowintegeropcional
Índice da linha da grade.
colintegeropcional
Índice da coluna da grade.
latnumberopcional
Latitude deste ponto da grade.
lngnumberopcional
Longitude deste ponto da grade.
ranknumberopcional
Classificação encontrada neste ponto (menor é melhor); null se não medido, valores acima de 20 significam "20+".
excludedbooleanopcional
Se este ponto está excluído dos cálculos estatísticos do local.
waterbooleanopcional
Se este ponto cai em água (mar, lago, rio largo) e só é contado se o local optou por incluir pontos em água.
statsobjectopcional
Estatísticas agregadas de classificação em toda a grade ativa.
top3Pctnumberopcional
Percentual de pontos da grade classificados entre os 3 primeiros, ou null.
top10Pctnumberopcional
Percentual de pontos da grade classificados entre os 10 primeiros, ou null.
avgRanknumberopcional
Classificação média em toda a grade, ou null.
statCardsobjectopcional
Cartões de destaque resumindo a melhor/pior palavra-chave do local e a maior variação mês a mês.
bestobjectopcional
A palavra-chave com a melhor (menor) classificação média atual, ou null se nenhuma tiver classificação.
keywordstringopcional
avgRanknumberopcional
worstobjectopcional
A palavra-chave com a pior classificação média atual, ou null.
keywordstringopcional
avgRanknumberopcional
gainerobjectopcional
A palavra-chave cuja classificação melhorou mais do seu primeiro ao seu mês mais recente, ou null.
keywordstringopcional
fromnumberopcional
tonumberopcional
dropperobjectopcional
A palavra-chave cuja classificação caiu mais do seu primeiro ao seu mês mais recente, ou null.
keywordstringopcional
fromnumberopcional
tonumberopcional
notRankingCountnumberopcional
Pontos da grade que foram medidos com sucesso, mas ficaram fora do top 20, ou null.
noDataCountnumberopcional
Pontos da grade que não puderam ser medidos (a extração falhou), distintos de não ter classificação, ou null.
centerobjectopcional
O ponto central do mapa para a grade deste local (sua localização comercial), ou null se ainda não configurado.
latnumberopcional
lngnumberopcional
includeWaterPointsbooleanopcional
Se este local optou por contar pontos da grade que caem em água.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/seo/keywords
Sua chave de API
locationId *
clientId
keywordId
month
{
  "data": {
    "keywords": [
      {
        "id": "cm_kw_abc123",
        "keyword": "dentist near me",
        "avgRank": 4.2,
        "monthly": [
          {
            "month": "2026-01",
            "rank": 5.1
          },
          {
            "month": "2026-02",
            "rank": 4.2
          }
        ]
      }
    ],
    "months": [
      {
        "key": "2026-01",
        "label": "Jan 2026",
        "avgRank": 5.1
      },
      {
        "key": "2026-02",
        "label": "Feb 2026",
        "avgRank": 4.2
      }
    ],
    "grid": [
      {
        "id": "cm_pt_1",
        "row": 0,
        "col": 0,
        "lat": 30.2682,
        "lng": -97.7441,
        "rank": 3,
        "excluded": false,
        "water": false
      }
    ],
    "stats": {
      "top3Pct": 44,
      "top10Pct": 78,
      "avgRank": 4.2
    },
    "statCards": {
      "best": {
        "keyword": "dentist near me",
        "avgRank": 4.2
      },
      "worst": {
        "keyword": "emergency dentist austin",
        "avgRank": 9.6
      },
      "gainer": {
        "keyword": "dentist near me",
        "from": 5.1,
        "to": 4.2
      },
      "dropper": {
        "keyword": "family dentist",
        "from": 3.8,
        "to": 5.2
      },
      "notRankingCount": 1,
      "noDataCount": 0
    },
    "center": {
      "lat": 30.2672,
      "lng": -97.7431
    },
    "includeWaterPoints": false
  }
}

Guias que usam este endpoint