POST: Extracting an event
POST api/v1/export/event
This is an API that can extract loaded events.
Query parameters
service_id
String
Service ID
Header
Content-Type
String
application/json
-
Authorization
String
Bearer your-auth-token
API Authentication Token
Request body
events
List of String
List of event names to filter, if no value exists, extract all events
events_condition_type
String
Filtering operator, supports the following values:
all: The whole event,
include: eventsIncludes only events of
exclude: eventsExcluding events
properties
List of String
List of event properties to filter on, if no value exists, extract all event properties
properties_condition_type
String
Filtering operator, supports the following values:
If the value does not exist: the entire event property,
all: All event properties,
include: propertiesContains only the event properties of
exclude: propertiesExcluding event properties
from_date
Date
Event search start date,yyyy-MM-dd, 2024-12-05
to_date
Date
Event search end date,yyyy-MM-dd, 2024-12-05
Response
The response from the event extraction ,is in CSV format with a header separated by. The first line is the header, and the extracted data is from the second line. The table below describes the main headers.
For the Unified ID and System Event properties properties, properties_condition_typethey are always included in the response, regardless of.
If no value exists, the default value is empty.
df_unified_id
Integrated ID
Integrated ID
${your-standard-event-property-key}
Standard event properties
Standard event properties
${your-custom-event-property-key}
Custom event properties
Custom event properties
${your-df-item-property-key}
Standard and custom event properties
Event Item (Standard, Custom) Properties
df_api_version
System Event Properties
Event API Version
event_name
System Event Properties
Event name
df_server_datetime
System Event Properties
Event log server arrival time
df_correction_datetime
System Event Properties
Event occurrence time
df_event_detail_log_id
System Event Properties
Event log ID, if the purchase event contains multiple items,
${df_event_log_id}:${n}It is in the form of.
df_event_log_id
System Event Properties
Event Log ID
Example request
Example response
Success response
Failure response
Last updated