A journey campaign's graph, per-step counts and enrolment totals

GET /campaigns/{id}/journey

A journey campaign's graph, per-step counts and enrolment totals

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/journey \
  --header 'Authorization: Bearer <token>'

200

{
  "workflowId": "<string>",
  "workflowName": "<string>",
  "workflowStatus": "<string>",
  "definition": {},
  "definitionVersion": 123,
  "mixedVersions": true,
  "enrolled": 123,
  "running": 123,
  "waiting": 123,
  "needsAttention": 123,
  "done": 123,
  "failed": 123,
  "notEnrolled": 123,
  "steps": [
    {
      "nodeId": "<string>",
      "reached": 123,
      "completed": 123,
      "failed": 123,
      "inFlight": 123,
      "skipped": 123,
      "ports": {},
      "avgDurationMs": 123
    }
  ]
}

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

workflowId · string · required

workflowName · string · required

workflowStatus · string · required

definition · object · required

Show child attributes

definitionVersion · integer · required

mixedVersions · boolean · required

enrolled · integer · required

running · integer · required

waiting · integer · required

needsAttention · integer · required

done · integer · required

failed · integer · required

notEnrolled · integer · required

steps · object[] · required

Show child attributes