Context API

요청

전체 요청소제목 링크 복사

외부 사용자 ID로 조회하는 전체 요청입니다. 토큰과 사용자 ID를 실제 값으로 바꿔 주세요. 다른 ID를 사용하는 요청은 아래 Payload 예시에서 확인할 수 있습니다.

POST /entry/inference/v1/context HTTP/1.1
Host: api.airbridge.io
Authorization: Bearer <AIRBRIDGE_APP_TOKEN>
Content-Type: application/json

{
  "airbridgeExternalUserId": "abc-123"
}

Payload 예시소제목 링크 복사

사용할 ID에 맞는 요청 예시를 탭별로 확인할 수 있습니다. 예시의 ID를 예측 데이터가 준비된 실제 테스트 사용자 ID로 바꿔 주세요.

{
  "airbridgeExternalUserId": "abc-123"
}

응답

Context API가 요청을 정상적으로 처리하면 HTTP 200과 JSON 본문을 반환합니다. context.lastTouchpoint는 설치에 기여한 광고 정보입니다. predictions에는 구매와 이탈 모델 각각의 probability와 tier가 모두 포함됩니다.

응답 예시소제목 링크 복사

아래 응답은 외부 사용자 ID abc-123으로 요청한 경우의 예시입니다. ID와 수치는 설명용 값입니다.

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: 01915c8e-7a12-7d3f-8b2a-1f2e3d4c5b6a

{
  "requestId": "01915c8e-7a12-7d3f-8b2a-1f2e3d4c5b6a",
  "appId": 1234,
  "user": {
    "id": "abc-123",
    "type": "airbridge_external_user_id"
  },
  "context": {
    "lastTouchpoint": {
      "channel": "media_A",
      "campaign": "moving_service",
      "adGroup": "moving_quote",
      "adCreative": "moving_guide_video",
      "term": null
    }
  },
  "predictions": {
    "d3_purchase": {
      "probability": 0.723,
      "tier": "high"
    },
    "d3_churn": {
      "probability": 0.812,
      "tier": "high"
    }
  }
}

Response body소제목 링크 복사

응답 해석소제목 링크 복사

구매와 이탈 모델의 예측 기간은 앱 설치 시점을 기준으로 합니다. 구매 모델이 예측하는 표준 주문 완료 이벤트는 airbridge.ecommerce.order.completed입니다.

예측 확률은 소수점 셋째 자리까지 반올림됩니다. 예시의 0.723은 72.3%를 뜻합니다. 등급은 반올림 전 확률과 각 모델의 학습 데이터에 대한 예측 확률 분포를 기준으로 정합니다. 서비스에서는 반환된 tier를 등급 조건으로 사용할 수 있습니다.

구매 모델과 이탈 모델은 서로 다른 사건을 예측합니다. 구매와 이탈 등급이 모두 high일 수 있습니다.

설치 유입 정보 해석소제목 링크 복사

context.lastTouchpoint는 설치에 기여한 채널과 캠페인 정보를 제공합니다. 설치 기여 결과가 없으면 객체 전체가 null입니다. 일부 정보만 없으면 해당 필드가 null이며, 객체에는 5개 키가 모두 포함됩니다.

restricted처럼 제공이 제한된 값은 전달받은 그대로 반환합니다. unattributed는 정보가 마스킹된 결과일 수 있습니다. 두 값 모두 null과 다르며, 이 값만으로 자연 유입 여부를 판단할 수 없습니다. 정보 제공이 제한되는 조건은 확장된 프라이버시 제어(EPC)에서 확인할 수 있습니다.

정상 값, 객체 전체의 null, 일부 필드의 null, restricted와 unattributed의 차이는 설치 유입 정보의 응답 사례 비교에서 확인할 수 있습니다. 캠페인과 예측값을 조합해 화면이나 메시지를 바꾸는 예시는 Context 활용하기에서 확인할 수 있습니다.

오류 응답소제목 링크 복사

Context API가 요청을 처리하지 못하면 오류에 해당하는 HTTP 상태 코드와 error를 반환합니다. 아래는 식별자 연결이나 예측 데이터를 찾지 못한 경우의 응답입니다.

HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: 01915c8e-7a12-7d3f-8b2a-1f2e3d4c5b6a

{
  "requestId": "01915c8e-7a12-7d3f-8b2a-1f2e3d4c5b6a",
  "error": {
    "code": "CONTEXT_DATA_NOT_FOUND",
    "message": "Context identifier or features were not found.",
    "retryable": false
  }
}

프로그램에서는 error.code로 오류를 구분하고 error.retryable로 재시도 여부를 판단해야 합니다. 오류 메시지의 문구를 실행 조건으로 사용하지 않아야 합니다. 전체 오류 코드와 기본 동작은 오류 처리에서 확인할 수 있습니다.