Customer Journey API

Get Journey stats

GET https://journey.pushwoosh.com/api/journey/{id}/statistics/external

Obtains stats for a specific journey by its ID. You can find the journey ID in the URL of the journey canvas page (see the picture below).

Authorize by API access token and send an empty request to the endpoint.

Headers

Name	Type	Description
Authorization	string	Journey ID

200: OK

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

Obtains stats for a specific journey by its ID. You can find the journey ID in the URL of the journey canvas page:

Authorize by API access token and send an empty request to the endpoint.

curl --location --request GET 'https://journey.pushwoosh.com/api/journey/<journey_id>/statistics/external' \
--header 'Authorization: Api <YOUR API TOKEN>'

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "First Point Title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "sent": 22648,
        "opened": 60,
        "uniqOpened": 60,
        "conversion": 0.26492405510420347
      }
    }]
  }
}

Remove users from journeys

This endpoint allows you to remove a list of users from all or specific active journeys.

POST https://journey.pushwoosh.com/api/journey/drop-users/external

Request headers

Header	Value
Content-Type	`application/json`
Authorization	`Bearer <your_token>`. A valid authentication token must be included in the `Authorization` header.

Request body

Send a JSON object with the following fields:

Field	Type	Required	Description
`user_ids`	`string[]`	Yes	List of user IDs to remove from journeys.
`journey_uuids`	`string[]`	Required if `all_journeys` is not provided or false.	List of journey UUIDs to remove users from.
`all_journeys`	`boolean`	Required if `journey_uuids` is not provided.	If true, users will be removed from all journeys. If false, `journey_uuids` must be provided.

Note: At least one of all_journeys (set to true) or journey_uuids (non-empty array) must be provided.

Request examples

Remove users from all journeys

{
  "user_ids": ["user1", "user2", "user3"],
  "all_journeys": true
}

Remove users from specific journeys

{
  "user_ids": ["user1", "user2"],
  "journey_uuids": ["journey-uuid-1", "journey-uuid-2"]
}

{
  "success": true
}

If the request is invalid, you will receive a 400 error with a descriptive message.

{
  "success": false,
  "message": "user_ids must be provided"
}

{
  "success": false,
  "message": "journey_uuids must be provided if all_journeys is false"
}