Export Raw User Data

The Raw Export API prepares raw user data, exports it to Insider One’s AWS S3 bucket, and sends a download link to your specified webhook endpoint. You can then access and transfer the data into your own systems.

What the export includes

• All requested attributes for each user.
• A list of events with their associated event parameters.
• You can filter the user set (e.g., only users who made a purchase yesterday).
• You can export attributes and events together, choosing which attributes to attach to each event entry.

Workflow

You should provide a webhook endpoint in the request to be notified when the export link is ready. After sending a request, your webhook endpoint receives an export link, allowing you to access the raw user data.

https://insider-data-export.useinsider.com/{partner name}/p/{file name}

You can export raw user data to analyze user information using a business intelligence (BI) tool and sync the data that you want via daily jobs.

Endpoint and Headers

POST https://unification.useinsider.com/api/raw/v1/export

Headers

Body Parameters

Before starting the implementation, make sure to share the following information with the Insider One team:

• A webhook endpoint that will be notified when the export link is ready
• A preferred format: CSV, Parquet, or JSON
• A list of attributes, events, and event parameters that you want to export
• A dynamic segment that you want to export

Sample Request

The sample below displays a request to get the raw user data with all attributes.

curl --location --request POST 'https://unification.useinsider.com/api/raw/v1/export' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
   "segment": {
        "segment_id": 123456789
    },
   "attributes":[
      "*"
   ],
   "events":{
      "start_date":1606311893,
      "end_date":1611582293,
      "wanted":[
         {
            "event_name":"email_click",
            "params":[
               "email_campaign_id",
               "timestamp"
            ],
            "filters": [
               {
                  "key": "email_campaign_id",
                  "operator": "eq",
                  "values": [369, 877]
               }
            ]
         },
         {
            "event_name":"item_added_to_cart",
            "params":[
               "product_id",
               "name",
               "timestamp"
            ]
         },
         {
            "event_name":"journey_entered",
            "params":[
               "journey_id",
               "timestamp"
            ]
         }
      ]
   },
   "format":"parquet",
   "hook":"https://xyz.test.com"
}'

The sample below displays a request to get the raw user data with selected attributes.

curl --location --request POST 'https://unification.useinsider.com/api/raw/v1/export' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
   "segment": {
        "segment_id": 123456789
    },
   "attributes": [
      "last_visited_product",
      "email",
      "name",
      "c_custom_attribute"
   ],
   "events": {
      "start_date": 1606311893,
      "end_date": 1611582293,
      "wanted": [
         {
            "event_name": "custom_event",
            "params": [
               "c_custom_parameter",
               "timestamp"
            ],
            "filters": [
               {
                  "key": "email_campaign_id",
                  "operator": "eq",
                  "values": [369, 877]
               }
            ]
         },
         {
            "event_name": "item_added_to_cart",
            "params": [
               "product_id",
               "name",
               "timestamp"
            ]
         },
         {
            "event_name": "journey_entered",
            "params": [
               "journey_id",
               "timestamp"
            ]
         }
      ]
   },
   "format": "parquet",
   "hook": "https://xyz.test.com"
}'

Sample Responses

200 OK

When the data is ready to download, you will receive the export link on your webhook URL as displayed below.

{"url":"https://insider-data-export.useinsider.com/{partner name}/p/{file name}"}

429 Too Many Requests

If you exceed the rate limits, you receive an error shown below:

{
    "error": "rejected: too many requests"
}

• 400 Empty Partner
• 400 Empty Token
• 403 Authentication Failed

Limitations

• All functions must be executed with a simple HTTPS POST request.
• Only a response stating whether the request is successful or failed can be received via this API. No data can be inserted.
• The request token should be provided in the request header. If the token is incorrect, the operation will not be executed.
• The exported data can be in CSV, Parquet (version 1.0), or JSON formats.
• The export link expires in 24 hours after it is ready.
• The rate limit for raw export is 1 request per day. Failed requests don't count. Based on the UTC zone, the API can be called only once in 24 hours. The limitation timeline resets at UTC 00:00.
• The value of X-PARTNER-NAME header should be lowercase.