POST: Extract user profile

POST api/v1/export/userprofile

This is an API that can extract loaded user profiles.

Query parameters

Name	Whether required	Type	Explanation
service_id	Essential	String	Service ID

Header

Field name	Whether required	Type	Value	Explanation
Content-Type	Essential	String	application/json	-
Authorization	Essential	String	Bearer your-auth-token	API Authentication Token

Request body

Field name	Whether required	Type	Explanation
properties	Select	List of String	List of user attribute names to filter on, if no value exists, extract all user attributes
properties_condition_type	Essential	String	Filtering operator, supports the following values: all: All user properties, include: propertiesContains only user properties of exclude: propertiesExcluding user properties of
audience	Select	String	Audience ID that includes the user you want to extract. If the value does not exist, extract all users.

Response

The response from the user profile 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 properties, properties_condition_typeit is always included in the response, regardless.

For more information about user profile properties, see the List of Standard User Profile Properties.

Field name	Division	Explanation
df_unified_id	Integrated ID	Integrated ID
${your-standard-user-property-key}	Standard User Profile Properties	Standard User Profile Properties
${your-custom-user-property-key}	Custom User Profile Properties	Custom User Profile Properties

Example request

curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/userprofile?service_id=${your-service-id}' \
  -d '{
    "audience": "nwh3nu",
    "properties_condition_type": "exclude",
    "properties": [
        "df_birth"
    ]
}'

Example response

Success response

custom_user_datetime,df_gender,df_kakao_ads_optin,df_membership,df_push_ads_optin,df_push_night_ads_optin,df_push_optin,df_sms_ads_optin,df_unified_id,scenario_list_string
,Male,false,,true,false,true,false,ZCUyK5F,"[""1"",""2""]"
,,false,,false,false,false,false,xrx4ib2,null
,,false,,false,false,true,false,BWCExSV,null
,,false,,false,false,false,false,uZFjOE3,null

Failure response

Please refer to the detailed response for more details.