POST: 이벤트 적재

POST /api/v1/events

이벤트 적재 API를 통해 하나 혹은 여러 이벤트를 한번에 적재할 수 있습니다. 적재하고자 하는 이벤트는 콘솔에서 사전 등록되어 있어야 합니다.

한번의 요청에서 최대 100개의 이벤트를 적재할 수 있습니다. 또한, 한번의 요청에서 최대 100개의 이벤트 아이템을 적재할 수 있습니다.

많은 이벤트를 적재 해야 한다면, 개별로 이벤트 적재 API를 호출하는 것 보다 여러 이벤트를 모아두었다가 한번에 이벤트 적재 API를 호출하는 것이 속도 및 요청 제한 측면에서 좋습니다. 연동 시에는 항상 요청 제한을 고려해야 합니다.

쿼리 파라미터

이름	필수값 여부	타입	설명
service_id	필수	String	서비스 ID

헤더

필드명	필수값 여부	타입	값	설명
Content-Type	필수	String	application/json	-
access_token	필수	String	your-api-token-key	API 인증 토큰

요청 본문

필드명	필수값 여부	타입	설명
common	필수	Object	이벤트 적재를 위한 공통 속성
events	필수	Array of Object	이벤트 정보

common

필드명	필수값 여부	타입	설명
identity	필수	Object	유저 식별자

identity

유저 식별자 정보입니다. 아래 필드 중 적어도 하나의 값을 넣어주어야 합니다.

필드명	필수값 여부	타입	설명
external_id	선택	String	외부 ID
phone_no	선택	String	전화 번호
email	선택	String	이메일
kakao_user_id	선택	String	카카오 ID
line_user_id	선택	String	라인 ID

events

이벤트 정보입니다. 적재하고자 하는 이벤트는 콘솔에서 사전 등록되어 있어야 합니다. 표준 이벤트와 이벤트 속성에 대한 자세한 내용은 사용자 가이드의 이벤트 텍소노미 설계하기를 참고해 주시면 됩니다.

필드명	필수값 여부	타입	설명
event_log_id	필수	String	이벤트 식별 ID, UUID Format, xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
event_name	필수	String	이벤트명
event_datetime	필수	Datetime	이벤트 발생 시각, UTC 타임존 기준
event_items	선택	Array of Object	상품 정보, Datetime 타입의 경우 UTC 타임존 기준
event_properties	선택	Object	이벤트 속성, Datetime 타입의 경우 UTC 타임존 기준

event_items

이벤트 아이템 속성입니다. 필드명은 콘솔에서 사전 등록된 아이템(df_item) 의 하위 속성명을, 값은 해당 속성의 값을 넣어주어야 합니다. 이벤트 아이템은 한번에 최대 100개까지 적재 가능합니다.

필드명	필수값 여부	타입	설명
${your-df-item-property-key}	선택	String, Long, Double, Boolean, Datetime, Array	사전 등록된 이벤트 아이템 속성 정보

event_properties

이벤트 속성입니다. 필드명은 아이템(df_item) 을 제외한 콘솔에서 사전 등록된 이벤트 속성의 속성명을, 값은 해당 속성의 값을 넣어주어야 합니다.

이름	필수값 여부	타입	설명
${your-event-property-key}	선택	String, Long, Double, Boolean, Datetime, Array	사전 등록된 이벤트 속성 정보

요청 예시

curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/events?service_id=${your-service-id}' \
  -d '{
  "common": {
    "identity": {
      "external_id": "dfn-user-123",
      "email": "[e-mail]"
    }
  },
  "events": [
    {
      "event_log_id": "b0c9cf18-f3c0-4879-bb2e-92c65858dabc",
      "event_name": "df_login",
      "event_datetime": "2024-06-24T06:01:48.501Z",
      "event_properties": null,
      "event_items": null
    },
    {
      "event_log_id": "464bc021-9c56-481e-8ee8-3bf06de7c418",
      "event_name": "df_purchase",
      "event_datetime": "2024-06-24T06:42:25.394Z",
      "event_properties": {
        "df_order_id": "dwtfmoe",
        "df_delivery_charge": 1000,
        "df_payment_method": "card",
        "df_total_purchase_amount": 4000
      },
      "event_items": [
        {
          "df_item_id": "1",
          "df_item_name": "item1",
          "df_price": 3000,
          "df_quantity": 1,
          "df_discount": 0
        }
      ]
    }
  ]
}'

응답 예시

정상 응답

Content-Type: application/json
access_token: ${your-api-token}
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}

실패 응답

자세한 내용은 상세 응답 참고하시면 됩니다.

40402 TOO_MANY_EVENTS

이벤트 수가 100개를 초과하거나, 이벤트 아이템 수가 100개를 초과한 경우입니다.

Content-Type: application/json
access_token: ${your-api-token}
{
  "status": false,
  "code": "40402",
  "message": "TOO_MANY_EVENTS",
  "data": true
}