v1Recursos/SEO/getConsultar o comprovante atribuído do orçamento de pesquisa
Consultar o comprovante atribuído do orçamento de pesquisa
Consulta a solicitação original no escopo do usuário atual, da agência e do piloto fixo do site de marketing da Synup. Exige locationId e a UUID externa requestId. Esta chamada nunca compra medições nem liquida créditos. Trabalhos reservados ou com resultado desconhecido retornam sua reserva retida; trabalhos liquidados ou com estouro podem incluir a medição exata salva. Um comprovante inexistente retorna 404 e nunca libera o bloqueio por incerteza do cliente que fez a chamada. Credenciais do provedor e identificadores privados de solicitações secundárias não são retornados.
get
seo:read/api/v1/seo/website-keywords/research-budgetParâmetros de consulta
locationIdstringobrigatório
requestIdstringobrigatório
Resposta
dataobjectobrigatório
requestIdstringobrigatório
currencystring (USD)obrigatório
dailyLimitUsdinteger (5)obrigatório
estimateIsAdmissionOnlyboolean (true)obrigatório
providerBillingGuaranteeboolean (false)obrigatório
operationstring (discovery | volumes | serp)obrigatório
statestring (reserved | unknown | settled | overrun)obrigatório
daystringobrigatório
reservedUsdnumberobrigatório
confirmedSpentUsdnumberobrigatório
measurementsobjectopcional
Resultado exato salvo da solicitação original atribuída a este processamento. GET o retorna após a liquidação ou um estouro. A ausência de resultado não significa volume de buscas zero, falta de posicionamento nem uma medição concluída com sucesso sem resultados. A estrutura segue a API de ideias de palavras-chave salvas ou de medições em lote.
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.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
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.
503O serviço está temporariamente indisponível. Siga as orientações de nova tentativa para esta operação.
get/api/v1/seo/website-keywords/research-budget
Sua chave de API
locationId *
requestId *
{}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.