Sign in

v1

latestOpenAPI 3.0.02026-07-23620132.5 KB
Scenarios / Logs

List scenario logs

Retrieves a collection of all logs for a scenario with a given ID. Returned logs are sorted by imtId in descending order.

get/scenarios/{scenarioId}/logs

Path parameters

scenarioIdinteger required

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Query parameters

frominteger

The timestamp in milliseconds that defines the starting point of time from which the logs should be retrieved. Older logs will not be returned.

tointeger

The timestamp in milliseconds that defines the ending point of time to which the logs should be retrieved. Newer logs will not be returned.

status1 | 2 | 3

Filters logs by the execution status. 1 is for success, 2 is for warning, and 3 is for error.

durationFrominteger

Filters logs to only include executions with a duration greater than or equal to this value (in milliseconds).

durationTointeger

Filters logs to only include executions with a duration less than or equal to this value (in milliseconds).

operationsFrominteger

Filters logs to only include executions with an operations count greater than or equal to this value.

operationsTointeger

Filters logs to only include executions with an operations count less than or equal to this value.

transferFrominteger

Filters logs to only include executions with a data transfer greater than or equal to this value (in bytes).

transferTointeger

Filters logs to only include executions with a data transfer less than or equal to this value (in bytes).

executionNamestring

Filters logs by the execution name (partial match).

creditsFrominteger

Filters logs to only include executions with credits greater than or equal to this value (in centicredits).

creditsTointeger

Filters logs to only include executions with credits less than or equal to this value (in centicredits).

showCheckRunsboolean

If set to true, check runs are included in the returned results. By default they are excluded. Check runs concern scenarios starting with a trigger in cases when the trigger does not find anything new.

pg[offset]integer

The number of entities you want to skip before getting entities you want.

pg[limit]integer

The maximum number of entities you want to get in the response.

pg[showLast]boolean

Include records with last value in the result set. Just in case of the last based paging.

pg[last]integer

The last retrieved key. In response, you get only entries that follow after the key.

pg[sortBy]string

The value that will be used to sort returned entities by.

pg[sortDir]'asc' | 'desc'

The sorting order. It accepts the ascending and descending direction specifiers.

Response

Successful response