- 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 pipeline snapshot
get
/text/Keywords/Optimization/Snapshots/{id}
This API endpoint retrieves details of a specific pipeline snapshot based on the provided snapshot ID.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| Id | string, required | Unique identifier for the pipeline snapshot. |
| Parameter Name | Type | Description |
|---|---|---|
| storeId | string, optional | Store ID identifying the snapshot's context. Default value: default. |
| type | string, optional | Specifies the type of snapshot, which can be either Product or Category. |
| recordId | string, optional | The Object ID associated with the snapshot. |
| languageCode | string, optional | The language in ISO 639-1 code with optional culture/country identifier (e.g. "en", "en-US"). Default is |
Response
200
400
404
500
//The request was successful, and the pipeline snapshot details are returned.
//The request failed due to invalid input or missing required parameters.
//The specified snapshot or related resource could not be found.
//The server encountered an error when processing the request.