API DocsRESTRun service

ListRuns

Retrieve runs using an optional filter.

GET
/api/v2/runs

Query Parameters

pageSizeinteger

The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuns must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are run_id, organization_id, name, description, created_by_user_id, modified_by_user_id, created_date, modified_date, start_time, stop_time, client_key, is_pinned, asset_id, client_key, and asset_name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

orderBystring

How to order the retrieved runs. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, start_time, and stop_time. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

curl -X GET "<API_URL>/api/v2/runs?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "runs": [
    {
      "runId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "organizationId": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "stopTime": "2019-08-24T14:15:22Z",
      "isPinned": true,
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "defaultReportId": "string",
      "clientKey": "string"
    }
  ],
  "nextPageToken": "string"
}