List step diff descriptions
Returns the textual description of all visual differences in a specific step (checkpoint) of a session. See Diff Descriptions for an explanation of the categories used.
Request
GET /batches/{batchId}/{sessionId}/{stepIndex}?[region=<region-identifier>]
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| batchId | string | path | The Batch's ID or Pointer ID. |
| sessionId | string | path | The ID of the test session that contains the step. |
| stepIndex | integer | path | The zero-based index of the step within the session. |
| region | string | query | Optional Restrict the returned descriptions to a specific area or region of the checkpoint. |
The response contains a textual description for each visual difference Eyes detected in the step. When no region parameter is supplied, descriptions for every diff in the step are returned.
cURL example
curl -H "X-Eyes-Api-Key: <your-api-key>" -X GET "https://eyes.applitools.com/api/v1/batches/<my_batch_ID>/<my_session_ID>/0"