v1Recursos/SEO/getObter o resumo de classificação de todos os locais
Obter 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.
get
seo:read/api/v1/seo/rollupParâ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"
]
}
]
}
}Guias que usam este endpoint
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Track Local Rankings with an APITrack local search rankings on a geo grid through an API, add keywords, read the grid and trend, and compare against competitors and citation coverage.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- Fetch Local Keyword Rankings via APITrack local search rankings on a geo grid with the Synup API, add keywords for a location, and read the rank trend once the background scan lands.