Sign in
latestOpenAPI 3.0.42026-08-2211752834.3 KB

fa74265a328d

JourneyMilestone

Get entity from JourneyMilestone by key

get/JourneyMilestone({Id})

Path parameters

Idnumber nullable required

Id of the JourneyMilestone

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

Idnumber

Internal identifier for ChurnZero.

Descriptionstring

The description for the JourneyMilestone.

ExpectedDurationnumber

The number of days an Account is expected to be in the JourneyMilestone.

JourneyIdnumber

The Id of the Journey this JourneyMilestone belongs to; see the Journey entity.

Namestring

The name of the JourneyMilestone.

ObjectCreatedDatestring date-time

The date/time the JourneyMilestone record was created. ISO 8601 formatted string.

ObjectLastModifiedDatestring date-time

The date/time the JourneyMilestone record was last modified. ISO 8601 formatted string.

ProgressBottomnumber

Progress Scale threshold, in days from the Account's Milestone start. An Account at or below this many days in the Milestone is 'On Track'; beyond it, 'Behind'.

ProgressTopnumber

Progress Scale threshold, in days from the Account's Milestone start. Beyond this many days the Account is 'Stuck' in the Milestone; between ProgressBottom and ProgressTop it is 'Behind'. A Behind or Stuck Milestone also raises the Account's overall Journey status (see JourneyMilestoneProgress and JourneyProgress).