v1Resources/SEO/postPreview, execute or reconcile volumes measurement
Preview, execute or reconcile volumes measurement
Exact caller list, including tracked keywords. One result per input reports measured (including zero), no_data, omitted or unsupported. Caller/provider keyword mapping uses case and whitespace normalization only. Search volume is an average monthly estimate; monthlySearches and dataMonth describe the available data period. Close variants may share volume; values must not be added together. Preview does not purchase or persist. Execute requires a stable UUID requestId and maxEstimatedCredits. Same-ID retries reuse saved status without another provider call; changed details return 409. GET never purchases. Reconcile only settles saved delivered receipts; unconfirmed provider outcomes remain held across discovery, volumes and SERP requests. Provider task IDs, costs and billing identities remain private. Existing credit gates apply.
post
seo:write/api/v1/seo/website-keywords/volumesResponse
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.
post/api/v1/seo/website-keywords/volumes
Your API key
{}Guides that use this resource
- 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.