GET

Get Site Keyword Research


Developer Preview

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

Retrieves a site keyword research run, including its status.

A content plan flow reaches KEYWORD_RESEARCH when research starts, not when it finishes. Retrieve the flow with Get Content Plan Flow, then specify its actual keywordResearchId and check that the returned research ID and contentPlanFlowId match. For research still IN_PROGRESS, use paced reads within a finite monitoring window. A brief not found error can occur before the research record exists; re-read the flow if it persists.

After matching research SUCCESS, re-read the same flow. Call Create Content Plan once only if the flow still reports KEYWORD_RESEARCH with that research ID and no release has already been attempted. If the flow has advanced to CONTENT_PLAN or SUCCESS, skip Create. Calling Create while research is IN_PROGRESS fails with FLOW_NOT_READY_FOR_CONTENT_PLAN.

Stop for FAIL, CANCELED, REVERTED, mismatched IDs or an expired monitoring window. Preserve the IDs and report the observed result. Elapsed time alone proves neither failure nor permission to start a replacement flow.

Omit keywordResearchId to retrieve the site's most recent successful research. A run that's still in progress is never returned this way, and a site with no successful research returns a not found error.

Permission Scopes
View SEO Settings
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/seo-content-plan-service/v1/site-keyword-research

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?