Customer Journey API

Get Journey stats

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

Returns statistics for a Customer Journey by its ID. Replace {id} in the URL with the Journey ID from the journey canvas page URL:

Send a GET request with no body.

Request headers

Name	Required	Value	Description
Authorization	Yes	Api <server_api_token>	Server API token.

Request example

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

Response example

200

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

In-app pointStat fields

The fields inside pointStat depend on the journey element’s channel. In-app elements return the metrics below instead of the sent, opened, and conversion fields shown in the response example above.

Field	Type	Description
shows	number	Number of times in-app messages were displayed to users. Labeled Impressions in Journey statistics.
interactions	number	Number of user interactions with the in-app message (for example, button clicks). Labeled Interactions in Journey statistics.
skipped	number	Number of times users skipped or dismissed the in-app message without interacting. Labeled In-App Skips in Journey statistics.

In-app response example

{
  "payload": {
    "title": "Journey Title",
    "points": [{
      "pointTitle": "In-App element title",
      "campaignCode": "AAAAA-00000",
      "presetCode": "12345-67890",
      "pointStat": {
        "shows": 3148,
        "interactions": 2759,
        "skipped": 36
      }
    }]
  }
}

Remove users from journeys

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

Removes a list of users from all or specific active journeys.

Request headers

Name	Required	Value	Description
Content-Type	Yes	application/json
Authorization	Yes	Api <server_api_token>	Server API token.

Request body

Field	Required	Type	Description
user_ids	Yes	string[]	List of User IDs to remove from journeys.
journey_uuids	Required if all_journeys is not provided or false	string[]	List of Journey IDs to remove users from.
all_journeys	Required if journey_uuids is not provided	boolean	If true, users are 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 example

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"]
}

Response example

200

{
  "success": true
}

400

If the request is invalid, the API returns HTTP 400 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"
}