Get keyword optimization data

get /text/Keywords/Optimization
This endpoint retrieves keyword-optimization data, including current status, ranking keywords, pipelines, and more.

Requirements

Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Parameters Type Description
storeId string The store identifier.
type string, required Specifies the type of entity, which can be either  Product or Category.
recordId string The object or record ID to retrieve optimization data for.
languageCode string The language in ISO 639-1 code with optional culture/country identifier (e.g. "en", "en-US").
rankingKeywords array A list of keywords that the page is already ranking for when keyword optimization starts (or when data is refreshed). Each object contains detailed keyword info, including search volume, difficulty, traffic potential, and SERP data.

Fields:
  • keyword (string) — The keyword.
  • date (string, date-time) — Date keyword data was retrieved.
  • position (int32) — Current SERP position, if monitored.
  • positionDelta (int32) — Change in position since last snapshot.
  • positionDate (string, date-time) — Last update date for position data.
  • searchVolume (int64) — Estimated monthly search volume.
  • difficulty (int32) — Difficulty to rank in top 10 results.
  • intent (string) — Search intent (navigational, informational, transactional, commercial).
  • intentDisplay (string) — Display label of the intent.
  • trafficPotential (int64) — Estimated traffic potential.
  • serpDate (string, date-time) — Date SERP results were last updated.
  • isSeed (boolean) — Whether the keyword is a seed keyword.
  • serpItems (array) — SERP results for the keyword, with each item including: url, domain, title, snippet, position.

Response

200
404
500
//When successful, the response contains a JSON object reflecting a Keyword Optimization Response.
//This error occurs if the specified data does not exist (for example, an invalid recordId).
//The server encountered an error when processing the request.