POST   checks/desktopapp/{checkId}/results

Get Desktop App check results in json format.

URL Parameters

NameDescription
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\": [
        \"756aab88-d789-422f-9087-81aeb68c43e7\",
        \"4fa00746-a7cc-4f70-a7a7-6ceab1f66d9d\",
        \"6a13334d-03fe-482b-9102-dd801b4ef0f8\"
      ]
    }
  }
}"
NameType 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": "3f3575c8-9310-4178-ae13-a492b2d42711",
      "total_execution_time_ms": 2342,
      "total_step_time_ms": 2745,
      "started_utc": "2024-11-09T00:49:37",
      "stopped_utc": "2024-11-09T00:49:37",
      "message": "OK",
      "severity": "I"
    },
    "steps": [
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "summary": {
      "result_id": "b99ef8c5-3a8f-4c04-b92f-b9f72738a1f4",
      "total_execution_time_ms": 2342,
      "total_step_time_ms": 2745,
      "started_utc": "2024-11-09T00:49:37",
      "stopped_utc": "2024-11-09T00:49:37",
      "message": "OK",
      "severity": "I"
    },
    "steps": [
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "summary": {
      "result_id": "6660d793-2c80-4813-9946-0f390444705e",
      "total_execution_time_ms": 2342,
      "total_step_time_ms": 2745,
      "started_utc": "2024-11-09T00:49:37",
      "stopped_utc": "2024-11-09T00:49:37",
      "message": "OK",
      "severity": "I"
    },
    "steps": [
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      },
      {
        "title": "processStep",
        "command_count": 10,
        "started_utc": "2024-11-09T00:49:37",
        "stopped_utc": "2024-11-09T00:49:37",
        "duration_ms": 3,
        "commands": [
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              },
              {
                "name": "duration",
                "value": "C:\\Windows\\System32\\*"
              }
            ]
          },
          {
            "name": "pause",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "template",
                "value": "initialStep"
              }
            ]
          },
          {
            "name": "startStep",
            "started_utc": "2024-11-09T00:49:37",
            "stopped_utc": "2024-11-09T00:49:37",
            "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": "C:\\Windows\\System32\\*"
              }
            ]
          }
        ]
      }
    ]
  }
]
NameType 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.