Synup
Create a key
v1Resources/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
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
deviceMetadataSourcestring (request_echo)optional
positionBasisstring (organic_rank_group)optional
featureCoveragestring (positive_observations_only)optional
resultsarray of objectoptional
callerKeywordstringoptional
providerKeywordstringoptional
collectedAtstringoptional
statusstring (found | not_found | incomplete | no_results)optional
completebooleanoptional
observedDepthintegeroptional
completedDepthintegeroptional
requestedobjectoptional
observedobjectoptional
locationCodenumberoptional
languagestringoptional
devicestringoptional
Provider request echo, not independent device verification.
enginestringoptional
checkedAtstringoptional
ownedResultsarray of objectoptional
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 objectoptional
firstPageFeaturesarray of stringoptional
Positive bounded feature-type sample only. Missing types do not establish absence. Uses page=1, or absolute slot <=10 only when page is missing.
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/serp
Your API key
locationId *
requestId *
{}

Guides that use this resource