- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- POSTArchive record
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
- TEMPLATE SETTINGS
- TOKEN
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:
|
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.