Task

Get Journey from Task

Changed on
get/Task({Id})/Journey

Request

  • Base URL: https://marketingpony.us1app.churnzero.net/public/v1
  • URL: https://marketingpony.us1app.churnzero.net/public/v1/Task({Id})/Journey
  • Auth: HTTP basic

Path parameters

Idnumber nullable required

Id of the Task

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved navigation property

Idnumber

Internal identifier for ChurnZero.

Descriptionstring

The description for the Journey.

ExpectedDurationnumber

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

IsActiveboolean

True if the Journey is currently running and being evaluated. Kept in sync with Status: activating a Draft or Paused Journey sets Status to Running, and deactivating a Running Journey sets Status to Paused.

IsSharedExternallyboolean

True if this Journey is configured for external sharing, which lets designated customer contacts view the Journey's progress and externally visible steps outside of ChurnZero.

Namestring

The name of the Journey.

ObjectCreatedDatestring date-time

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

ObjectLastModifiedDatestring date-time

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

ProgressBottomnumber

Progress Scale threshold, in days from the Account's Journey start (Days In). An Account at or below this many days is OnTrack; beyond it is Behind. (Set per Journey in the Progress Scale; need not be a fixed fraction of ExpectedDuration.)

ProgressTopnumber

Progress Scale threshold, in days from the Account's Journey start (Days In). Beyond this the Account is 'Stuck'; between ProgressBottom and ProgressTop it is 'Behind'. Note an Account's overall Journey Status (JourneyProgress.Status) is also raised to the worst of its in-progress Milestones, so it can read 'Stuck' before Days In reaches ProgressTop.

Statusstring

The Journey's configuration lifecycle state: Draft, Paused, Running (shown as 'Active' in the ChurnZero UI), or MarkedForDeletion. This describes the Journey definition itself, NOT an Account's progress — an Account's OnTrack/Behind/Stuck progress status lives on the JourneyProgress entity's Status.

Changes