v1Recursos/SEO/getLer campos de palavras-chave tipados, histórico de campanhas e visualizações salvas acessíveis
Ler campos de palavras-chave tipados, histórico de campanhas e visualizações salvas acessíveis
Requer as duas flags de website, um usuário ativo e identificado da agência com acesso a SEO e acesso a este website ou cliente não arquivado. Visualizações privadas pertencem a esse usuário. Definições de campos e visualizações de equipe exigem proprietário ou admin; membros autorizados podem editar valores e campanhas. Nunca inicia verificações de ranking nem consome créditos.
get
seo:read/api/v1/seo/website-keywords/workspaceParâmetros de consulta
locationIdstringobrigatório
configstringopcional
Colunas, filtros, campaignMonth e ordenação codificados em JSON. Omita para a visualização padrão.
Resposta
dataobjectopcional
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.
409expectedVersion desatualizada, ou um mutationId reutilizado com um comando diferente.
413A solicitação excede 1 MB.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503Não foi possível concluir a operação.
get/api/v1/seo/website-keywords/workspace
Sua chave de API
locationId *
config
{}Guias que usam este recurso
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- 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 Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.
- 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.