Customer Journey API

Получение статистики Journey

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

Позволяет получить статистику для конкретного Journey по его ID. Вы можете найти ID Journey в URL страницы Journey canvas (см. изображение ниже).

Авторизуйтесь с помощью API access token и отправьте пустой запрос на эндпоинт.

Заголовки

Имя	Тип	Описание
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
      }
    }]
  }
}

Позволяет получить статистику для конкретного Journey по его ID. Вы можете найти Journey ID в URL страницы Journey canvas:

Авторизуйтесь с помощью API access token и отправьте пустой запрос на эндпоинт.

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

Удаление пользователей из Journey

Этот эндпоинт позволяет удалить список пользователей из всех или конкретных активных Journey.

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

Заголовки запроса

Заголовок	Значение
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`. Действующий токен аутентификации должен быть включен в заголовок `Authorization`.

Тело запроса

Отправьте JSON-объект со следующими полями:

Поле	Тип	Обязательно	Описание
`user_ids`	`string[]`	Да	Список User ID для удаления из Journey.
`journey_uuids`	`string[]`	Обязательно, если `all_journeys` не указан или равен false.	Список UUID Journey, из которых нужно удалить пользователей.
`all_journeys`	`boolean`	Обязательно, если `journey_uuids` не указан.	Если true, пользователи будут удалены из всех Journey. Если false, необходимо указать `journey_uuids`.

Примечание: Необходимо указать хотя бы одно из полей: all_journeys (установлено в true) или journey_uuids (непустой массив).

Примеры запроса

Удаление пользователей из всех Journey

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

Удаление пользователей из конкретных Journey

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

{
  "success": true
}

Если запрос недействителен, вы получите ошибку 400 с описанием причины.

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

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