Automation run steps

Get automation run steps

Returns automation run steps matching the filters: run, automation, automation step, button, contact, completion status, and created and completed date ranges. For incremental export, poll with createdDateFrom for new steps and with completedDateFrom for steps that finished later, sorted by CreatedDate. Paginate with skip and take (take up to 1000). Full records are always returned. Requires permission to view automations.

get/api/v1/student-scenario-progress

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-progress
  • Auth: API key in header Authorization

Query parameters

idstring

ID

studentScenarioIdstring

Automation run ID

scenarioNodeIdstring

Automation step ID

scenarioNodePortIdstring

Step port (button) ID

isCompletedboolean

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

hasPortIdboolean

Has a port (button press)

studentIdsstring[]

Contact IDs

studentScenarioIdsstring[]

Automation run IDs

contactIdstring

Contact ID

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)

scenarioIdstring

Automation ID

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

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.