- WriteText.ai API Overview
- 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 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 | Two-letter language code, e.g., en. Default is en. |
Response
200
400
404
500
//The request was successful, and the pipeline snapshot details are returned.
xxxxxxxxxx1
{2
"id": "string",3
"date": "2025-01-27T06:47:30.138Z",4
"data": {5
"id": "string",6
"date": "2025-01-27T06:47:30.138Z",7
"status": "string",8
"statusMessage": "string",9
"refreshStatus": "NoOngoing",10
"completedSteps": 0,11
"totalSteps": 0,12
"storeId": "string",13
"type": "string",14
"recordId": "string",15
"languageCode": "string",16
"countryCode": "string",17
"imageId": "string",18
"intents": [19
"string"20
],21
"availableClustersToRestore": 0,22
"trafficPotential": 0,23
"trafficPotentialDisplay": "string",24
"optimizingKeywordsDisplay": "string",25
"rankingKeywords": [26
{27
"keyword": "string",28
"date": "2025-01-27T06:47:30.138Z",29
"position": 0,30
"positionDelta": 0,31
"positionDate": "2025-01-27T06:47:30.138Z",32
"searchVolume": 0,33
"difficulty": 0,34
"intent": "string",35
"intentDisplay": "string",36
"trafficPotential": 0,37
"serpDate": "2025-01-27T06:47:30.138Z",38
"isSeed": true,39
"serpItems": [40
{41
"url": "string",42
"domain": "string",43
"title": "string",44
"snippet": "string",45
"position": 046
}47
]48
}49
],50
"snapshots": [51
{52
"id": "string",53
"date": "2025-01-27T06:47:30.138Z"54
}55
]56
}57
}//The request failed due to invalid input or missing required parameters.
xxxxxxxxxx1
{2
"type": "string",3
"title": "string",4
"status": 400,5
"detail": "Invalid request",6
"instance": "string",7
"additionalProp1": "string",8
"additionalProp2": "string",9
"additionalProp3": "string"10
}//The specified snapshot or related resource could not be found.
xxxxxxxxxx1
{2
"type": "string",3
"title": "string",4
"status": 404,5
"detail": "Snapshot not found",6
"instance": "string",7
"additionalProp1": "string",8
"additionalProp2": "string",9
"additionalProp3": "string"10
}//The server encountered an error when processing the request.
x
1