Synupv1
Criar chave
v1Recursos/SEO

SEO

Acompanhe classificações de palavras-chave de busca local em uma grade geográfica, a posição dos concorrentes, e os insights e recomendações gerados por IA do Sydekick.

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.

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

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
  }
}
v1Recursos/SEO/postAdicionar palavras-chave monitoradas a um local

Começa a monitorar uma ou mais palavras-chave na grade de classificação de busca local de um local, configurando o tamanho e o raio da grade na primeira vez em que o local é configurado. As palavras-chave são desduplicadas sem diferenciar maiúsculas/minúsculas e limitadas a 25 por local. Dispara uma varredura de classificação em segundo plano para cada palavra-chave recém-adicionada — consulte GET /api/v1/seo/keywords depois para ver os resultados chegarem.

Adicionar palavras-chave monitoradas a um local

post/api/v1/seo/keywords
seo:write
Corpo da solicitação
locationIdstringobrigatório
O local para o qual monitorar palavras-chave.
clientIdstringopcional
O cliente do local.
keywordsarray of stringobrigatório
Palavras-chave a começar a monitorar, até 25 (desduplicadas sem diferenciar maiúsculas/minúsculas; a primeira grafia enviada prevalece).
gridSizeinteger (3 | 5 | 7)opcional
Tamanho da grade (3, 5 ou 7 pontos por lado). Aplicado apenas na primeira vez em que a grade deste local é configurada — chamadas posteriores que omitem isso, ou que visam um local já configurado, deixam o tamanho da grade armazenado inalterado.
distanceKmnumberopcional
Distância em quilômetros entre pontos adjacentes da grade. Mesma regra de aplicação apenas na primeira vez que gridSize; o padrão é 1,5 km quando o local ainda não tem uma grade configurada.
excludedarray of objectopcional
Pontos da grade a excluir da medição — ex.: um lago, o território de um concorrente. Os pontos ainda são coletados de qualquer forma; isso só controla se contam nas estatísticas.
rowintegeropcional
Índice de linha da grade, começando em 0.
colintegeropcional
Índice de coluna da grade, começando em 0.
Resposta
dataobjectopcional
keywordsarray of objectopcional
As palavras-chave que foram adicionadas ou reativadas por esta chamada.
idstringopcional
Identificador único da palavra-chave monitorada.
keywordstringopcional
O texto da palavra-chave como armazenado (usando a primeira grafia enviada).
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.
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/seo/keywords
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "keywords": [
      {
        "id": "cm_kw_abc123",
        "keyword": "dentist near me"
      }
    ]
  }
}
v1Recursos/SEO/deleteRemover uma palavra-chave monitorada

Para de monitorar uma palavra-chave e exclui seus relatórios de classificação armazenados.

Remover uma palavra-chave monitorada

delete/api/v1/seo/keywords
seo:write
Parâmetros de consulta
keywordIdstringobrigatório
A palavra-chave monitorada a ser removida.
clientIdstringopcional
O cliente do local proprietário da palavra-chave.
Resposta
dataobjectopcional
removedbooleanopcional
Sempre true — a palavra-chave e seus relatórios de classificação armazenados foram removidos.
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.
delete/api/v1/seo/keywords
Sua chave de API
keywordId *
clientId
{
  "data": {
    "removed": true
  }
}
v1Recursos/SEO/patchAtualizar a configuração de grade de um local

Atualiza a configuração de medição da grade de um local: tamanho da grade, distância entre pontos, pontos excluídos, ou se os pontos de água contam nas estatísticas. Envie apenas os campos que deseja alterar. Os pontos de água são sempre coletados de qualquer forma — includeWaterPoints só controla se são contados e exibidos. O lado de leitura já é coberto por GET /api/v1/seo/keywords, cuja resposta já inclui includeWaterPoints.

Atualizar a configuração de grade de um local

patch/api/v1/seo/config
seo:write
Corpo da solicitação
locationIdstringobrigatório
O local a configurar.
clientIdstringopcional
O cliente do local.
gridSizeinteger (3 | 5 | 7)opcional
Tamanho da grade: 3, 5 ou 7.
distanceKmnumberopcional
Distância em quilômetros entre pontos adjacentes da grade.
excludedarray of objectopcional
Pontos da grade a excluir da medição.
rowintegeropcional
Índice de linha da grade, começando em 0.
colintegeropcional
Índice de coluna da grade, começando em 0.
includeWaterPointsbooleanopcional
Se os pontos de água da grade contam nas estatísticas.
Resposta
dataobjectopcional
configobjectopcional
A configuração de grade do local após a atualização.
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.
patch/api/v1/seo/config
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "config": {
      "id": "cm_cfg_abc123",
      "synupLocationId": "os_9f8e7d6c",
      "clientLocationId": "cm_loc_1",
      "agencyId": "cm_agency_1",
      "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
      "centerLat": 30.2672,
      "centerLng": -97.7431,
      "gridSize": 5,
      "distanceKm": 1.5,
      "excludedPoints": [
        {
          "row": 4,
          "col": 4
        }
      ],
      "generationStartedAt": null,
      "lastRunStatus": "complete",
      "lastError": null,
      "includeWaterPoints": true,
      "lastGeneratedAt": "2026-02-01T06:00:00.000Z",
      "createdAt": "2026-01-10T09:00:00.000Z",
      "updatedAt": "2026-02-05T10:00:00.000Z"
    }
  }
}
v1Recursos/SEO/postBaixar um relatório de classificação com identidade visual

Gera o relatório de classificação com identidade visual e seções configuráveis — a mesma ação "Baixar relatório" no aplicativo. Retorna HTML renderizado, não um PDF binário: a renderização em PDF acontece no navegador (nenhum renderizador Chrome headless é executado no servidor), então transformar isso em um arquivo PDF real fica por conta de quem chama, a mesma limitação que a própria interface do aplicativo tem. Diferente de POST /api/v1/seo/reports/generate, que apenas enfileira uma varredura da grade de classificação em segundo plano e não retorna documento algum.

Baixar um relatório de classificação com identidade visual

post/api/v1/seo/reports
seo:read
Corpo da solicitação
locationIdstringobrigatório
O local sobre o qual gerar o relatório.
presetstringopcional
Predefinição de período, ex.: "lastMonth" (padrão).
fromstringopcional
Início do período personalizado (data ISO). Requer to.
tostringopcional
Fim do período personalizado (data ISO). Requer from.
keywordsarray of stringopcional
Limitar a esses ids de palavras-chave monitoradas. Omita para incluir todas.
sectionsobjectopcional
Quais seções do relatório incluir, por chave. Chaves omitidas usam os padrões do relatório.
coverPagebooleanopcional
executiveSummarybooleanopcional
performanceSnapshotbooleanopcional
agencyActivityLogbooleanopcional
gridRankSnapshotsbooleanopcional
keywordPerformanceTablebooleanopcional
monthOverMonthTrendbooleanopcional
competitorLandscapebooleanopcional
aiRecommendationsbooleanopcional
notesstringopcional
Notas em texto livre para incluir no relatório.
localestringopcional
Idioma do relatório gerado. Padrão en.
Resposta
dataobjectopcional
htmlstringopcional
O relatório gerado como um documento HTML autocontido.
filenamestringopcional
Nome de arquivo sugerido para o relatório.
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.
502O relatório não pôde ser gerado (uma falha na fonte de dados, não um erro do cliente).
post/api/v1/seo/reports
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "html": "<style>#seo-report{width:100%;...}</style><div id=\"seo-report\"><section class=\"cover\"><h1>Ranking Analytics Report</h1><div class=\"biz\">Acme Dental — Downtown</div></section>...</div>",
    "filename": "Acme_Dental_Downtown_RankingReport_Jan2026_Feb2026.pdf"
  }
}
v1Recursos/SEO/getObter o resumo de classificação de todos os locais

Retorna uma linha de resumo por local que tem pelo menos um relatório de classificação, opcionalmente restrita a um cliente e/ou tags de local. Uma chave restrita a clientes específicos deve passar clientId.

Obter o resumo de classificação de todos os locais

get/api/v1/seo/rollup
seo:read
Parâmetros de consulta
clientIdstringopcional
Restringe os resultados a um cliente. Quando sua chave está limitada a clientes específicos, isso é obrigatório.
tagsstringopcional
Lista de nomes de tags de local separados por vírgula. Somente locais com pelo menos uma dessas tags são incluídos.
Resposta
dataobjectopcional
countnumberopcional
Número de linhas retornadas.
rowsarray of objectopcional
Uma linha por local com pelo menos um relatório de classificação.
idstringopcional
Identificador único do local.
locationNamestringopcional
O nome comercial do local.
citystringopcional
Cidade, ou null.
avgRanknumberopcional
Classificação média entre as palavras-chave ativas do local, ou null.
top3Pctnumberopcional
Percentual médio de pontos da grade entre os 3 primeiros nas palavras-chave do local, ou null.
top10Pctnumberopcional
Percentual médio de pontos da grade entre os 10 primeiros nas palavras-chave do local, ou null.
bestKeywordobjectopcional
A palavra-chave com melhor classificação do local, ou null.
keywordstringopcional
avgRanknumberopcional
tagsarray of stringopcional
As tags internas do local.
Erros
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/rollup
Sua chave de API
clientId
tags
{
  "data": {
    "count": 2,
    "rows": [
      {
        "id": "cm_loc_1",
        "locationName": "Acme Dental — Downtown",
        "city": "Austin",
        "avgRank": 4.2,
        "top3Pct": 44,
        "top10Pct": 78,
        "bestKeyword": {
          "keyword": "dentist near me",
          "avgRank": 4.2
        },
        "tags": [
          "priority",
          "downtown"
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObter o ranking de concorrentes de um local

Retorna os negócios que dominam a grade de classificação deste local para sua palavra-chave monitorada mais recente, classificados por quanto da grade ocupam entre os 3 primeiros. Inclui seu próprio negócio (isYou) para comparação, e marca entradas já no seu registro de concorrentes monitorados com o ID do registro.

Obter o ranking de concorrentes de um local

get/api/v1/seo/competitors
seo:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringopcional
O cliente do local.
Resposta
dataobjectopcional
countnumberopcional
Número de concorrentes retornados.
competitorsarray of objectopcional
O ranking de concorrentes, incluindo seu próprio negócio.
idstringopcional
Um identificador para este negócio (seu place ID, ou uma chave derivada quando nenhum place ID está disponível).
competitorIdstringopcional
ID no seu registro de concorrentes monitorados, presente apenas quando este negócio já é monitorado ali.
namestringopcional
Nome do negócio.
isYoubooleanopcional
Se esta linha é o seu próprio negócio.
ratingnumberopcional
Classificação em estrelas, ou null.
reviewCountnumberopcional
Número de avaliações, ou null.
avgRanknumberopcional
Classificação média nos pontos da grade em que este negócio apareceu, ou null.
top3Pctnumberopcional
Percentual de pontos da grade em que este negócio classifica entre os 3 primeiros, calculado em todas as palavras-chave monitoradas.
gridPointsnumberopcional
Número de pontos da grade em que este negócio apareceu.
categorystringopcional
Categoria do negócio, ou null.
websitestringopcional
Site do negócio, ou null (não retornado pela fonte de dados de busca local).
keywordBreakdownarray of objectopcional
A cobertura entre os 3 primeiros deste negócio detalhada por palavra-chave monitorada.
keywordstringopcional
A palavra-chave monitorada.
top3Pctnumberopcional
Percentual dos pontos da grade dessa palavra-chave em que este negócio classifica entre os 3 primeiros.
featureComparisonarray of objectopcional
Linhas de comparação de recursos contra o seu negócio, se houver.
featurestringopcional
competitorbooleanopcional
youbooleanopcional
hoursComparisonarray of objectopcional
Linhas de comparação de horário de funcionamento contra o seu negócio, se houver.
daystringopcional
competitorstringopcional
youstringopcional
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/competitors
Sua chave de API
locationId *
clientId
{
  "data": {
    "count": 2,
    "competitors": [
      {
        "id": "cm_comp_1",
        "competitorId": "cm_competitor_1",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "rating": 4.6,
        "reviewCount": 210,
        "avgRank": 4.2,
        "top3Pct": 44,
        "gridPoints": 25,
        "category": "Dentist",
        "website": "https://acmedental.example.com",
        "keywordBreakdown": [
          {
            "keyword": "dentist near me",
            "top3Pct": 60
          }
        ],
        "featureComparison": [
          {
            "feature": "Online booking",
            "competitor": false,
            "you": true
          }
        ],
        "hoursComparison": [
          {
            "day": "Monday",
            "competitor": "9am–5pm",
            "you": "8am–6pm"
          }
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObter tendências de classificação de concorrentes ao longo do tempo

Retorna a classificação média mensal de cada concorrente no histórico de classificação monitorado deste local (até os últimos 12 meses medidos), para o gráfico de tendência de classificação. Inclui seu próprio negócio (isYou).

Obter tendências de classificação de concorrentes ao longo do tempo

get/api/v1/seo/competitors/trends
seo:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
clientIdstringopcional
O cliente do local.
Resposta
dataobjectopcional
monthsarray of stringopcional
Meses cobertos, do mais antigo ao mais recente (YYYY-MM).
competitorsarray of objectopcional
Uma série por concorrente (além do seu próprio negócio), alinhada aos meses.
placeIdstringopcional
Um identificador para este negócio (seu place ID, ou uma chave derivada).
namestringopcional
Nome do negócio.
isYoubooleanopcional
Se esta série é o seu próprio negócio.
monthlyarray of numberopcional
Classificação média para cada mês em months; null onde este negócio não foi observado naquele mês.
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/competitors/trends
Sua chave de API
locationId *
clientId
{
  "data": {
    "months": [
      "2026-01",
      "2026-02"
    ],
    "competitors": [
      {
        "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "monthly": [
          5.1,
          4.2
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObter negócios classificados em um ponto da grade

Retorna os resultados de busca local capturados em uma única célula da grade para uma palavra-chave, em ordem de classificação.

Obter negócios classificados em um ponto da grade

get/api/v1/seo/grid-point
seo:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado.
keywordIdstringobrigatório
A palavra-chave monitorada a que pertence a grade deste ponto.
rowintegerobrigatório
Índice da linha da grade do ponto.
colintegerobrigatório
Índice da coluna da grade do ponto.
clientIdstringopcional
O cliente do local.
monthstringopcional
Fixa o resultado neste mês (YYYY-MM) em vez do relatório mais recente medido da palavra-chave.
Resposta
dataobjectopcional
countnumberopcional
Número de negócios retornados.
businessesarray of objectopcional
Negócios classificados neste ponto da grade, em ordem de classificação.
idstringopcional
Um identificador para este negócio (seu place ID, nome, ou posição na lista).
ranknumberopcional
A classificação deste negócio neste ponto da grade (1 = primeiro).
namestringopcional
Nome do negócio.
photoUrlstringopcional
URL da foto, ou null (não retornado pela fonte de dados de busca local).
ratingnumberopcional
Classificação em estrelas, ou null.
reviewCountnumberopcional
Número de avaliações, ou null.
categorystringopcional
Categoria do negócio, ou null.
addressstringopcional
Endereço, ou null.
websitestringopcional
Site do negócio, ou null (não retornado pela fonte de dados de busca local).
isYoubooleanopcional
Se esta linha é o seu próprio negócio.
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/grid-point
Sua chave de API
locationId *
keywordId *
row *
col *
clientId
month
{
  "data": {
    "count": 1,
    "businesses": [
      {
        "id": "cm_biz_1",
        "rank": 3,
        "name": "Acme Dental — Downtown",
        "photoUrl": null,
        "rating": 4.6,
        "reviewCount": 210,
        "category": "Dentist",
        "address": "123 Main St, Austin, TX 78701",
        "website": null,
        "isYou": true
      }
    ]
  }
}
v1Recursos/SEO/postRegenerar o relatório de grade de classificação de um local

Dispara uma nova extração em segundo plano da grade de classificação de busca local para um local e/ou uma palavra-chave monitorada específica. Isso é disparar-e-esquecer: a chamada retorna imediatamente após o job ser enfileirado, e o novo relatório chega de forma assíncrona — consulte GET /api/v1/seo/keywords (ou GET /api/v1/seo/competitors, etc.) depois para vê-lo.

Regenerar o relatório de grade de classificação de um local

post/api/v1/seo/reports/generate
seo:write
Corpo da solicitação
locationIdstringopcional
Regenera a grade de cada palavra-chave ativa para este local. Opcional se keywordId for informado.
keywordIdstringopcional
Regenera a grade apenas para esta palavra-chave monitorada. Opcional se locationId for informado.
monthstringopcional
Gera a grade de classificação deste mês (YYYY-MM) em vez do mês atual.
clientIdstringopcional
O cliente do local (ou do local proprietário da palavra-chave).
Resposta
dataobjectopcional
generatingbooleanopcional
Sempre true — um job de geração em segundo plano foi enfileirado.
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.
post/api/v1/seo/reports/generate
Sua chave de API
Corpo da solicitação
{
  "data": {
    "generating": true
  }
}