Synupv1
Create a key
v1Resources/SEO/postRegenerate a location's ranking-grid report

Regenerate a location's ranking-grid report

Triggers a background rescrape of the local-search ranking grid for a location and/or a specific tracked keyword. This is fire-and-forget: the call returns immediately once the job is enqueued, and the new report lands asynchronously — poll GET /api/v1/seo/keywords (or GET /api/v1/seo/competitors, etc.) afterward to see it.

post/api/v1/seo/reports/generate
seo:write
Request body
locationIdstringoptional
Regenerate every active keyword's grid for this location. Optional if keywordId is given.
keywordIdstringoptional
Regenerate the grid for this one tracked keyword only. Optional if locationId is given.
monthstringoptional
Generate this month's ranking grid (YYYY-MM) instead of the current month.
clientIdstringoptional
The location's (or keyword's owning location's) client.
Response
dataobjectoptional
generatingbooleanoptional
Always true — a background generation job was enqueued.
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/seo/reports/generate
Your API key
Request body
{
  "data": {
    "generating": true
  }
}