Get test executions list

Gets the status of the running or recently completed executions matching the specified filter parameters.

All executions in the last 24 hours are available.

Request syntax

Copy

Syntax

https://<tenant-name>.perfectomobile.com/scriptless/api/executions

Method

GET

Header parameters

Name

Description

Perfecto-Authorization

The Perfecto security token. For more information, see Generate a security token.

Important: All REST API commands require authentication. See the general authentication methods in Authentication and authorization.

Request body

Name Type Default value Max value Description

byAllUsers

boolean

false

N/A

Set to true to include executions started by all users on the specific cloud to which the current user belongs in the response.

offest

number

0

N/A

The starting point for fetching the executions.

limit

number

100

1000

The number of executions to display in a single API call.

* Mandatory

Response

Name Description

executionId

The unique identifier that you can use to get the status of the running script or abort it. The identifier is only valid during, and for a short period after, the script's execution.

tenantId

The identifier for the tenant or cloud that started the execution.

userId

The identifier for the user that started the execution.

devices

The information of the devices used in the script. Includes the idmanufacturer and model.

reportKey 

The identifier that you can use to download the execution report from the repository. The key is only valid once the script's execution completes and does not expire. For example, PRIVATE:reportName.xml.

status

The current status of the execution. The following is a list of the possible return values:

  • Initializing: The execution is initializing and preparing to run the specified script

  • Running: The execution is performing the functions coded in the script

  • Terminating: The execution completed the last function in the script and is performing cleanup operations, e.g. finalizing the video, updating data structures, releasing resources.

  • Completed: The execution has completed and is no longer running

progressPercentage

The progress percentage of the running execution.

description

The description of the current execution status.

numberOfFailedCommands

The count of failed commands.

endCode

The completion code of the execution. The following is a list of the possible return values:

  • Success

  • Failed

  • UserAborted

parent

If the execution was invoked by another execution, this field contains the execution identifier of the parent execution. This field can be used to identify child executions, or to query the status of a parent execution.

tracking

The time tracking details for the test execution.

  • createdat: The test creation time

  • lastUpdatedAt: The time when the test was last updated

total

The number of executions in the system.

Examples

This section lists several usage examples.

Copy

Request

https://demo.perfectomobile.com/scriptless/api/executions
https://demo.perfectomobile.com/scriptless/api/executions?byAllUsers=true
https://demo.perfectomobile.com/scriptless/api/executions?offset=10&limit=100
Copy

JSON response

{
    "executions": [
        {
            "executionId": "ac04d299-a365-408e-b96b-f7b4689fce36",
            "tenantId": "test-perfectomobile-com",
            "userId": "user-name@perforce.com",
            "reportKey": "https://test.app.perfectomobile.com/reporting/library?externalId[0]=ac04d299-a365-408e-b96b-f7b4689fce36",
            "status": "Completed",
            "progressPercentage": 100,
            "devices": [
                {
                    "deviceName": "00008110-0014516422EA801E",
                    "platformName": "iOS",
                    "platformVersion": "15.0"
                },
                {
                    "deviceName": "19081FDF6007QX",
                    "platformName": "Android",
                    "platformVersion": "14"
                }
            ],
            "endCode": "FAILED",
            "description": "Test execution failed inside embedded test.",
            "numberOfFailedCommands": 4,
            "tracking": {
                "createdAt": 1757055808819,
                "lastUpdatedAt": 1757056046747
            }
        },
        {
            "executionId": "c43e3c45-61a2-4ddc-be90-037bb722f9a2",
            "tenantId": "test-perfectomobile-com",
            "userId": "user-name@perforce.com",
            "reportKey": "https://test.app.perfectomobile.com/reporting/library?externalId[0]=c43e3c45-61a2-4ddc-be90-037bb722f9a2",
            "status": "Completed",
            "progressPercentage": 100,
            "devices": [],
            "endCode": "SUCCESS",
            "description": "Completed",
            "numberOfFailedCommands": 0,
            "tracking": {
                "createdAt": 1756989081803,
                "lastUpdatedAt": 1756989104056
            }
        }
    ],
    "meta": {
        "total": 127,
        "limit": 2,
        "offset": 0
    }
}