v1Resources/SEO/getRead an owned research-budget receipt
Read an owned research-budget receipt
Read the original request in the current user, agency and fixed Synup marketing-website pilot scope. Requires locationId and the external requestId UUID. This never purchases measurements or settles credits. Reserved or unknown work returns its retained reservation; settled/overrun work can include its exact saved measurement. A missing receipt returns 404 and never releases a client uncertainty hold. Provider credentials and private child request identities are not returned.
get
seo:read/api/v1/seo/website-keywords/research-budgetQuery parameters
locationIdstringrequired
requestIdstringrequired
Response
dataobjectrequired
requestIdstringrequired
currencystring (USD)required
dailyLimitUsdinteger (5)required
estimateIsAdmissionOnlyboolean (true)required
providerBillingGuaranteeboolean (false)required
operationstring (discovery | volumes | serp)required
statestring (reserved | unknown | settled | overrun)required
daystringrequired
reservedUsdnumberrequired
confirmedSpentUsdnumberrequired
measurementsobjectoptional
Exact saved result for the original owned request, exposed on GET after settlement (or overrun). Absence is not zero search volume, a missing ranking, or an empty successful measurement. Shapes follow the saved discovery or batch measurement API.
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.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Follow the retry guidance for this operation.
get/api/v1/seo/website-keywords/research-budget
Your API key
locationId *
requestId *
{}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.