POST checks/desktopapp/{checkId}/results
Get Desktop App check results in json format.
URL Parameters
| Name | Description |
|---|---|
| checkId | Check identifier. Type: numeric. |
Remarks
The default context for the route is the user context. To enable customer context (if it's allowed for the user) use the request query parameter customer_context=1.
Request example and description
curl --request POST "https://api-asm1.apica.io/v3/checks/desktopapp/12345/results?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
\"include\": {
\"steps\": {
\"commands\": {
\"only_with_screenshots\": true,
\"arguments\": {}
}
}
},
\"filter\": {
\"range\": {
\"mostrecent\": 10,
\"milliseconds_utc\": [
1376980667000,
1376980667001
],
\"period\": {
\"from_utc\": \"2013-08-20T13:32:08\",
\"to_utc\": \"2013-08-21T13:32:08\"
},
\"result_ids\": [
\"e6be9292-2dbe-4f63-b8c2-43267775ff3f\",
\"899ce536-4a3d-452a-b487-79d98d2c5462\",
\"d10f5461-2239-45e4-ab6b-1d2d09e52a28\"
]
}
}
}"
| Name | Type | Required | Description |
|---|---|---|---|
| include | Object | No |
The include section defines additional Desktop App check results information to include into the response (if it exists and can be retrieved). If this section omitted or empty, the response will only contain basic data. |
| steps | Object | No |
Specify the steps section to include data from steps. For including, use values: {} or true. For not including do not specify this section or use value: false. |
| commands | Object | No |
Specify the commands section to include data from commands. For including, use values: {} or true. For not including do not specify this section or use value: false. |
| only_with_screenshots | Boolean | No |
The only_with_screenshots flag indicates that information about commands should be included only for commands with screenshots. Default value: false. |
| arguments | Object | No |
Specify the arguments section to include data from arguments. For including, use values: {} or true. For not including do not specify this section or use value: false. |
| filter | Object | Yes |
The filter section defines the criteria for selecting the check results. |
| range | Object | Yes |
This section allows to define the aggregate range of the results by combining different filters. It must contain at least one filter. |
| mostrecent | Integer | No |
Number of most recent results. |
| milliseconds_utc | Array | No |
Array of timestamps associated with results. Each item is represented by a UNIX Epoch timestamp (milliseconds after 1970). |
| period | Object | No |
The period section defines the date range to obtain results for. |
| from_utc | DateTime | Yes |
Starting timestamp (in UTC) for the date range. |
| to_utc | DateTime | Yes |
Ending timestamp (in UTC) for the date range. |
| result_ids | Array | No |
Array of result identifiers to specific results. |
Response body model example and description
[
{
"summary": {
"result_id": "2a6ef553-74e2-4141-9e3a-801536f1a51c",
"total_execution_time_ms": 2342,
"total_step_time_ms": 2745,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"message": "OK",
"severity": "I"
},
"steps": [
{
"title": "endStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startApplication",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
},
{
"name": "template",
"value": "initialStep"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "startStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "endStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
}
]
},
{
"summary": {
"result_id": "94b8ba51-5225-4352-b0e7-e00d824f5c21",
"total_execution_time_ms": 2342,
"total_step_time_ms": 2745,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"message": "OK",
"severity": "I"
},
"steps": [
{
"title": "endStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startApplication",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
},
{
"name": "template",
"value": "initialStep"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "startStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "endStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startApplication",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
},
{
"name": "template",
"value": "initialStep"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
}
]
},
{
"summary": {
"result_id": "79711173-593a-4753-932c-aaa487c1a96a",
"total_execution_time_ms": 2342,
"total_step_time_ms": 2745,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"message": "OK",
"severity": "I"
},
"steps": [
{
"title": "startStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "endStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
},
{
"title": "startStep",
"command_count": 10,
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"duration_ms": 3,
"commands": [
{
"name": "startStep",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "duration",
"value": "C:\\Windows\\System32\\*"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
},
{
"name": "pause",
"started_utc": "2024-12-22T08:59:04",
"stopped_utc": "2024-12-22T08:59:04",
"elapsed_ms": 4563,
"ignore_timing": true,
"screenshot_id": "408b07ee-XXXX-XXXX-XXXX-afb20a4c7352",
"error_message": "Path not found.",
"arguments": [
{
"name": "template",
"value": "initialStep"
},
{
"name": "template",
"value": "initialStep"
},
{
"name": "stepName",
"value": "1000"
}
]
}
]
}
]
}
]
| Name | Type | Description |
|---|---|---|
| summary | Object |
The result summary. |
| result_id | Guid |
The result identifier. |
| total_execution_time_ms | Integer |
Total execution time in ms. |
| total_step_time_ms | Integer |
Total steps time in ms. |
| started_utc | DateTime |
Start timestamp. |
| stopped_utc | DateTime |
Stopped timestamp. |
| message | String |
The result message. |
| severity | String |
The result severity. |
| steps | Array |
Result's steps. |
| title | String |
The title of the step. |
| command_count | Integer |
Count of commands. |
| started_utc | DateTime |
Started timestamp. |
| stopped_utc | DateTime |
Stopped timestamp. |
| duration_ms | Integer |
The step duration in ms. |
| commands | Array |
Step commands. |
| name | String |
Command name. |
| started_utc | DateTime |
Started timestamp. |
| stopped_utc | DateTime |
Stopped timestamp. |
| elapsed_ms | Integer |
Elapsed time in ms. |
| ignore_timing | Boolean |
'Ignore timing' status. |
| screenshot_id | String |
Screenshot ID can be numeric or GUID. |
| error_message | String |
Error message. |
| arguments | Array |
Command arguments. |
| name | String |
Argument name. |
| value | String |
Argument value. |