POST: 이벤트 추출

POST api/v1/export/event

적재되어있는 이벤트를 추출할 수 있는 API 입니다.

쿼리 파라미터

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

헤더

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

요청 본문

필드명	필수값 여부	타입	설명
events	선택	List of String	필터링 대상 이벤트명 리스트, 값이 존재하지 않을 경우 모든 이벤트 추출
events_condition_type	필수	String	필터링 연산자, 아래 값을 지원합니다. all : 전체 이벤트, include : events의 이벤트만 포함, exclude : events의 이벤트 제외
from_date	필수	Date	이벤트 조회 시작일, yyyy-MM-dd, 2024-12-05
to_date	선택	Date	이벤트 조회 종료일, yyyy-MM-dd, 2024-12-05

요청 예시

curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/event?service_id=${your-service-id}' \
  -d '{
    "events": ["df_purchase"],
    "events_condition_type": "include",
    "from_date": "2024-08-25",
    "to_date": "2024-08-26"
}'

응답

이벤트 추출의 응답은 , 로 구분되는 헤더가 포함된 csv 포맷입니다. 첫번째 줄이 헤더이고, 두번째 줄부터 추출된 데이터입니다. 아래의 표는 주요 헤더에 대한 설명입니다.

이벤트 속성에 대한 자세한 내용은 이벤트 택소노미 설계하기 를 참고하시면 됩니다.

필드명	구분	설명
${your-standard-event-property-key}	표준 이벤트 속성	표준 이벤트 속성
${your-custom-event-property-key}	커스텀 이벤트 속성	커스텀 이벤트 속성
${your-df-item-property-key}	표준, 커스텀 이벤트 속성	이벤트 아이템 (표준, 커스텀) 속성
df_api_version	시스템 이벤트 속성	이벤트 API 버전
event_name	시스템 이벤트 속성	이벤트명
df_server_datetime	시스템 이벤트 속성	이벤트 로그 서버 도달 시각
df_correction_datetime	시스템 이벤트 속성	이벤트 발생 시각
df_event_detail_log_id	시스템 이벤트 속성	이벤트 로그 ID, 구매 이벤트에서 여러 아이템이 포함되어 있는 경우, ${df_event_log_id}:${n} 의 형태입니다.
df_event_log_id	시스템 이벤트 속성	이벤트 로그 ID

성공 응답

200 OK

custom_012,custom_event_p_boolean,custom_event_p_boolean2,custom_event_p_datetime,custom_event_p_double,custom_event_p_double_list,custom_event_p_long,custom_event_p_long_list,custom_event_p_string_list,custom_user_id,df_api_version,df_correction_datetime,df_delivery_charge,df_discount,df_event_datetime,df_event_detail_log_id,df_event_log_id,df_event_name,df_items_custom_012391239128,df_items_custom_item_boolean,df_items_custom_item_datetime,df_items_custom_item_double,df_items_custom_item_double_list,df_items_custom_item_long,df_items_custom_item_long_list,df_items_custom_item_string,df_items_custom_item_string_list,df_items_df_category1,df_items_df_category2,df_items_df_category3,df_items_df_category4,df_items_df_category5,df_items_df_discount,df_items_df_item_id,df_items_df_item_name,df_items_df_price,df_items_df_quantity,df_keyword,df_order_id,df_payment_method,df_server_datetime,df_service_id,df_sharing_channel,df_sign_channel,df_source_type,df_total_purchase_amount,df_total_refund_amount,sum
,false,false,,,null,,null,null,,v1,2024-11-25 11:16:40.565,2500,,2024-11-25 11:16:40.565,1732501000568:77a47b2b-e3c6-4663-8281-2cd4625b1825:1,1732501000568:77a47b2b-e3c6-4663-8281-2cd4625b1825,df_purchase,,false,,,null,,null,,null,식품,과자,,,,400,,과자 오징어땅콩 ,28000,5,,order_1732501000564,BankTransfer,2024-11-25 11:16:40.568,xyroon,,,SDK,57000,,
,false,false,,,null,,null,null,,v1,2024-11-25 11:17:05.978,1100,,2024-11-25 11:17:05.978,1732501025981:76b4d082-f3a8-41e9-a971-2289205c6d22:1,1732501025981:76b4d082-f3a8-41e9-a971-2289205c6d22,df_purchase,,false,,,null,,null,,null,식품,과자,,,,250,,과자 허니버터칩 ,20000,2,,order_1732501025978,BankTransfer,2024-11-25 11:17:05.981,xyroon,,,SDK,43000,,
,false,false,,,null,,null,null,,v1,2024-11-25 11:17:05.978,1100,,2024-11-25 11:17:05.978,1732501025981:76b4d082-f3a8-41e9-a971-2289205c6d22:2,1732501025981:76b4d082-f3a8-41e9-a971-2289205c6d22,df_purchase,,false,,,null,,null,,null,식품,과자,,,,450,,과자 먹태깡 ,23000,3,,order_1732501025978,BankTransfer,2024-11-25 11:17:05.981,xyroon,,,SDK,43000,,
,false,false,,,null,,null,null,,v1,2024-11-25 14:08:55.791,1400,,2024-11-25 14:08:55.791,1732511335816:93461566-6fef-4592-8457-ebb16fd552a7:1,1732511335816:93461566-6fef-4592-8457-ebb16fd552a7,df_purchase,,false,,,null,,null,,null,식품,과자,,,,350,,과자 새우깡 ,20000,6,,order_1732511335791,BankTransfer,2024-11-25 14:08:55.816,xyroon,,,SDK,44000,,
,false,false,,,null,,null,null,,v1,2024-11-25 14:08:55.791,1400,,2024-11-25 14:08:55.791,1732511335816:93461566-6fef-4592-8457-ebb16fd552a7:2,1732511335816:93461566-6fef-4592-8457-ebb16fd552a7,df_purchase,,false,,,null,,null,,null,식품,과자,,,,400,,과자 고래밥 ,24000,4,,order_1732511335791,BankTransfer,2024-11-25 14:08:55.816,xyroon,,,SDK,44000,,
,false,false,,,null,,null,null,,v1,2024-11-25 15:01:12.344,1700,,2024-11-25 15:01:12.344,1732514472344:3d9ec73c-9fb5-4213-94c8-378b3ad66763:1,1732514472344:3d9ec73c-9fb5-4213-94c8-378b3ad66763,df_purchase,,false,,,null,,null,,null,식품,과자,,,,350,,과자 고래밥 ,28000,4,,order_1732514472344,BankTransfer,2024-11-25 15:01:12.344,xyroon,,,SDK,54000,,
,false,false,,,null,,null,null,,v1,2024-11-25 15:01:12.344,1700,,2024-11-25 15:01:12.344,1732514472344:3d9ec73c-9fb5-4213-94c8-378b3ad66763:2,1732514472344:3d9ec73c-9fb5-4213-94c8-378b3ad66763,df_purchase,,false,,,null,,null,,null,식품,과자,,,,50,,과자 감자깡 ,26000,5,,order_1732514472344,BankTransfer,2024-11-25 15:01:12.344,xyroon,,,SDK,54000,,
,false,false,,,null,,null,null,,v1,2024-11-25 15:30:50.73,1700,,2024-11-25 15:30:50.73,1732516250799:cbfae1ba-b1c1-400f-b644-6738e0e7d266:1,1732516250799:cbfae1ba-b1c1-400f-b644-6738e0e7d266,df_purchase,,false,,,null,,null,,null,식품,과자,,,,150,,과자 도리토스 ,27000,8,,order_1732516250730,BankTransfer,2024-11-25 15:30:50.799,xyroon,,,SDK,51000,,
,false,false,,,null,,null,null,,v1,2024-11-25 15:30:50.73,1700,,2024-11-25 15:30:50.73,1732516250799:cbfae1ba-b1c1-400f-b644-6738e0e7d266:2,1732516250799:cbfae1ba-b1c1-400f-b644-6738e0e7d266,df_purchase,,false,,,null,,null,,null,식품,과자,,,,250,,과자 치토스 ,24000,5,,order_1732516250730,BankTransfer,2024-11-25 15:30:50.799,xyroon,,,SDK,51000,,

실패 응답

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