Synup
Create a key
v1Resources/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
Query parameters
locationIdstringrequired
requestIdstringrequired
Response
dataobjectoptional
requestIdstringoptional
statusstring (pending | ready | partial | failed | unknown)optional
keywordsarray of stringoptional
estimatedCreditsnumberoptional
recordedCreditsnumberoptional
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)optional
generatedAtstringoptional
Record update time; use each observation timestamp for measurement age.
stepsarray of objectoptional
Join keywords against results and steps. Failed or skipped measurements have no result; absence is not zero volume or outside-depth ranking.
keywordsarray of stringoptional
statusstring (queued | submitting | ready | failed | skipped | unknown)optional
deliveredbooleanoptional
closeVariantsMayShareVolumebooleanoptional
volumesAreAdditivebooleanoptional
keywordMatchingstring (trim_whitespace_case_only)optional
volumeDefinitionstring (average_monthly_searches)optional
dataMonthDefinitionstring (latest_monthly_series_entry)optional
resultsarray of objectoptional
callerKeywordstringoptional
providerKeywordstringoptional
collectedAtstringoptional
statusstring (measured | no_data | omitted | unsupported)optional
volumenumberoptional
Average monthly estimate; measured zero is different from null.
dataMonthstringoptional
Newest monthlySearches entry, not the single-month basis of volume.
monthlySearchesarray of objectoptional
yearintegeroptional
monthintegeroptional
volumenumberoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409Request identity mismatch, concurrent request or pending/unknown research hold.
422A valid website or adequate maxEstimatedCredits is required.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503Measurement or durable credit settlement unavailable. Preserve the requestId and read saved status before retrying.
get/api/v1/seo/website-keywords/volumes
Your API key
locationId *
requestId *
{}

Guides that use this resource