- 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 status of generated texts
get
/text/Generate/Status
This method retrieves the status of all generated text, including generated, edited, reviewed, and transferred text. The results can be filtered by various criteria such as type, storeId, language, date range, username, and status.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Parameter Name | Type | Description |
---|---|---|
type | string, required | Specifies the type of text to retrieve (e.g., "Product", "Category"). |
storeId | string, optional | Filters results by the store ID. |
language | string, optional | Filters results by language code. |
startDate | string, date-time, optional | The inclusive start date for filtering results. |
endDate | string, date-time, optional | The exclusive end date for filtering results. |
userName | string, optional | Filters results by username. |
fields | array of strings, optional | Filters results by text types. |
status | array of strings, optional | Filters by generation status, such as "Generated", "Edited", "Reviewed", "Transferred". |
continuationToken | string, optional | The token used to retrieve the next page of results. |
pageSize | integer, optional | Specifies the number of results per page (default=100). |
Response
200
401
500
//This status is returned when the status of all generated text is successfully retrieved.
//This status is returned if the API key is missing or invalid.
//The server encountered an error when processing the request.
Parameter Name | Type | Description |
---|---|---|
continuationToken | string | The token used to retrieve the next page of results if there are more available. |
records | array of objects | The list of records containing the status of each generated text, including:
|