Get Executions for an Automation

get

https://api.zylo.com/v2/automations/{automationId}/executions

Required Permissions

automations

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

automationId

string

required

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Stringified UUIDv4.

Query Params

automation_id

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

The automation that produced this execution.

automation_name

string

The name of the automation that produced this execution.

automation_state

string

enum

Whether the parent automation is ACTIVE or INACTIVE.

Allowed:

category_tags

array of strings

Category tags assigned to the parent automation.

category_tags

created_by

string

The user who triggered the execution.

error_cause

string

Root cause of the execution failure.

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Unique identifier for the execution.

messages_errored

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of messages that failed to send.

messages_queued

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of messages queued during the execution.

messages_sent

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of messages successfully sent.

start_time

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

When the execution started.

status

string

enum

The execution status (SUCCESS, ERROR, STOPPED, TIMED OUT, IN PROGRESS).

Allowed:

stop_time

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

When the execution finished.

tickets_created

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of tickets created during the execution.

tickets_errored

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of tickets that failed to create.

trigger

string

enum

Whether the execution was triggered On Demand or by a Schedule.

Allowed:

zylo_created_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date the execution record was created.

zylo_modified_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date the execution record was last modified.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok