Contact automation runs

Get automation runs

Returns contacts' automation runs filtered by automation, contact, completion status, and creation and completion date ranges. Paginate with skip and take (take up to 1000). The fields parameter is optional; without it, whole records are returned. Requires permission to view automations.

get/api/v1/student-scenario

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/student-scenario
  • Auth: API key in header Authorization

Query parameters

idstring

ID

contactIdstring

Contact ID

scenarioIdstring

Automation ID

webinarIdstring

Webinar ID

chatConversationIdstring

Chat conversation ID

chatChannelIdstring

Chat channel ID of the automation

scenarioChatBotIdstring

Chatbot ID of the automation

telegramGroupIdstring

Telegram group ID of the automation

scenarioChatBotType'simple' | 'webinar'

Chatbot type of the automation

blockingNodeIdstring

ID of the step the run is waiting on

isCompletedboolean

Completed (true: finished only, false: in progress only)

blockingScenarioIdstring

ID of the automation whose step the run is waiting on

blockingNodeIdsstring[]

IDs of the steps the run is waiting on

chatConversationIdsstring[]

Chat conversation IDs

studentIdsstring[]

Contact IDs

scenarioIdsstring[]

Automation IDs

createdDateFromstring date-time

Created on or after (UTC, inclusive)

createdDateTostring date-time

Created before (UTC, exclusive)

completedDateFromstring date-time

Completed on or after (UTC, inclusive)

completedDateTostring date-time

Completed before (UTC, exclusive)

timezoneOffsetMininteger

Time zone offset in minutes

skipEmptyListboolean

Ignore empty lists

itemsTotalinteger

Total items

takeinteger

Number of results per page

skipinteger

Number of records to skip

searchstring

Search phrase

sortNamestring

Property to sort by

sortType'asc' | 'desc'

Sort order

useSortboolean

Apply sorting

useBaseFilterboolean

Use base filter

useItemsTotalboolean

Count total records

softDeletedboolean

Soft-deleted

idsstring[]

List of unique identifiers

fieldsstring

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the sample server response for the full list of fields.

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.