Synup
Criar chave
v1Recursos/SEO/getRead saved volumes measurement

Read saved volumes measurement

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

get/api/v1/seo/website-keywords/volumes
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
closeVariantsMayShareVolumebooleanopcional
volumesAreAdditivebooleanopcional
keywordMatchingstring (trim_whitespace_case_only)opcional
volumeDefinitionstring (average_monthly_searches)opcional
dataMonthDefinitionstring (latest_monthly_series_entry)opcional
resultsarray of objectopcional
callerKeywordstringopcional
providerKeywordstringopcional
collectedAtstringopcional
statusstring (measured | no_data | omitted | unsupported)opcional
volumenumberopcional
Average monthly estimate; measured zero is different from null.
dataMonthstringopcional
Newest monthlySearches entry, not the single-month basis of volume.
monthlySearchesarray of objectopcional
yearintegeropcional
monthintegeropcional
volumenumberopcional
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/volumes
Sua chave de API
locationId *
requestId *
{}

Guias que usam este recurso