Customer Journey API

获取 Journey 统计数据

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

通过 ID 获取特定 Journey 的统计数据。您可以在 Journey canvas（旅程画布）页面的 URL 中找到 Journey ID（见下图）。

使用 API Access Token 进行授权，并向端点发送空请求。

Headers

名称	类型	描述
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
      }
    }]
  }
}

通过 ID 获取特定 Journey 的统计数据。您可以在 Journey canvas 页面的 URL 中找到 Journey ID：

使用 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

请求头

Header	值
Content-Type	`application/json`
Authorization	`Bearer \<your_token\>`。必须在 `Authorization` 头中包含有效的身份验证令牌。

请求体

发送包含以下字段的 JSON 对象：

字段	类型	必填	描述
`user_ids`	`string[]`	是	要从 Journey 中移除的 User ID 列表。
`journey_uuids`	`string[]`	如果未提供 `all_journeys` 或其为 false，则必填。	要从中移除用户的 Journey UUID 列表。
`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"
}