Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Persons

List person steps

Returns campaign flow steps for the specified person, sorted by event date in descending order. Steps represent discrete tracked actions (e.g. conversion, share, reward earned) within the person's journey.

get/v5/persons/{person_id}/steps

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Query parameters

namesstring[]
containersstring[]
campaign_idsstring[]
programsstring[]
journey_namesstring[]
is_primaryboolean
data_keysstring[]
event_idsstring[]
cause_event_idsstring[]
root_event_idsstring[]
offsetinteger
limitinteger
journey_key_namesstring[]
journey_key_valuesstring[]

Response

Successful response

campaign_idstring required

Extole campaign id associated with this step. Absent when no campaign is linked.

cause_event_idstring required

Id of the direct cause event for this step.

containerstring required

Campaign container the step belongs to.

created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

dataobject required

Named data parameters attached to this step.

event_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

event_idstring required

Extole event id that triggered this step.

idstring required

Extole-assigned unique identifier for this step.

is_primaryboolean required

Whether this is the primary (first qualifying) step for this event type in the journey.

journey_namestring required

Journey name associated with this step. Absent for global-scope steps.

namestring required

Name of the event type that created this step (e.g. purchase, signup).

programstring required

Program key associated with this step. Absent when no program context exists.

quality'HIGH' | 'LOW' | 'NONE' required

Quality classification of the step (GOOD or BAD).

root_event_idstring required

Id of the root event that initiated the chain leading to this step.

scope'CLIENT' | 'PRIVATE' | 'PUBLIC' required

Scope of the step (GLOBAL or JOURNEY).

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Example response

[
  {
    "created_date": "2025-10-24T02:00:00-07:00",
    "event_date": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]