POST

Trigger Page Optimization


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Starts generating optimization suggestions for a site page.

The suggestions target the page's focus keyword, so set it first: run keyword research, set the chosen keyword as the page's focus keyword, then trigger. Returns a predictionId to poll Get Page Optimization Results with.

Triggering is idempotent per page: while a generation for the page is in progress, calling again returns the same predictionId instead of starting a new job, unless the page's focus keyword changed since the job started, which returns a SUGGESTIONS_ALREADY_IN_PROGRESS error.

Must be called with a Wix user identity. Calls made with an API key fail.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage SEO Settings
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/seo/suggestions/v1/page-optimization/trigger

Errors
428Failed Precondition

There are 4 errors with this status code.

429Resource Exhausted

There is 1 error with this status code.

500Internal

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?