Synup
Criar chave
v1Recursos/SEO/getRead saved serp measurement

Read saved serp measurement

Read the request in the current agency/client scope. Never purchases a measurement.

get/api/v1/seo/website-keywords/serp
seo:read
Parâmetros de consulta
locationIdstringobrigatório
requestIdstringobrigatório
Resposta
dataobjectopcional
requestIdstringopcional
statusstring (pending | ready | partial | failed | unknown)opcional
keywordsarray of stringopcional
estimatedCreditsnumberopcional
recordedCreditsnumberopcional
Known ledger credits after settlement, with internal/staging exemption applied. Null for unknown or unsettled outcomes; never infer provider USD from credits.
settlementstring (pending | settled | unknown)opcional
generatedAtstringopcional
Record update time; use each observation timestamp for measurement age.
stepsarray of objectopcional
Join keywords against results and steps. Failed or skipped measurements have no result; absence is not zero volume or outside-depth ranking.
keywordsarray of stringopcional
statusstring (queued | submitting | ready | failed | skipped | unknown)opcional
deliveredbooleanopcional
deviceMetadataSourcestring (request_echo)opcional
positionBasisstring (organic_rank_group)opcional
featureCoveragestring (positive_observations_only)opcional
resultsarray of objectopcional
callerKeywordstringopcional
providerKeywordstringopcional
collectedAtstringopcional
statusstring (found | not_found | incomplete | no_results)opcional
completebooleanopcional
observedDepthintegeropcional
completedDepthintegeropcional
requestedobjectopcional
observedobjectopcional
locationCodenumberopcional
languagestringopcional
devicestringopcional
Provider request echo, not independent device verification.
enginestringopcional
checkedAtstringopcional
ownedResultsarray of objectopcional
All observed owned organic URLs in requested scope. Position is organic rank_group, not absolute SERP slot. A positive found observation may be partial; absence requires complete depth.
firstPageResultsarray of objectopcional
firstPageFeaturesarray of stringopcional
Positive bounded feature-type sample only. Missing types do not establish absence. Uses page=1, or absolute slot <=10 only when page is missing.
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.
409Request identity mismatch, concurrent request or pending/unknown research hold.
422A valid website or adequate maxEstimatedCredits is required.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503Measurement or durable credit settlement unavailable. Preserve the requestId and read saved status before retrying.
get/api/v1/seo/website-keywords/serp
Sua chave de API
locationId *
requestId *
{}

Guias que usam este recurso