Customer Journey API

Journey 통계 가져오기

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

ID 로 특정 Journey 에 대한 통계를 가져옵니다. Journey 캔버스 페이지의 URL 에서 Journey ID 를 찾을 수 있습니다 (아래 그림 참조).

API 액세스 토큰으로 인증하고 엔드포인트에 빈 요청을 보냅니다.

헤더

이름	유형	설명
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 캔버스 페이지의 URL 에서 Journey ID 를 찾을 수 있습니다:

API 액세스 토큰으로 인증하고 엔드포인트에 빈 요청을 보냅니다.

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[]`	예	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"
}