- 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
- 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
Get keyword optimization List
get
/text/Keywords/Optimization/List
This endpoint retrieves a list of keyword optimization entries based on the specified filters, allowing you to view their statuses, record details, and related metadata.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, optional | The store identifier. Defaults to "default" if not provided. |
| type | string, optional | Specifies the type of entity, which can be either Product or Category. |
| languageCode | string, optional | A 2-letter language code. Default: en. |
| status | array[string], optional | Filter by keyword optimization status. Available values: Pending, InProgress, Completed, Failed, Manual. |
| recordIds | array [string], optional | Filter by record IDs. |
| continuationToken | string, optional | A token used to retrieve the next page of results. |
| pageSize | integer, optional | The number of records to retrieve per page. Default value: 100. |
Example API Request
//https://api-eu.writetext.ai/text/Keywords/Optimization/List?storeId=exampleStore&type=Product&status=Pending&pageSize=50
Response
200
400
500
//The request was successful, and a list of keyword optimization records was returned.
//This error occurs when the request contains invalid parameters or data.
//The server encountered an error when processing the request.