Export Raw User Data

Overview

This API prepares the raw user data, exports it into Insider's AWS S3 Bucket and returns a link to your webhook endpoint as a response. This link enables you to have access to the raw user data and to transfer it to your end.

The API prepares the raw user data for all users for all attributes of those requested, and for a list of events and the event parameters of these events. You can filter to narrow down the user set (e.g. the raw user data can return the users that have made a purchase in the last day).

The API can prepare the raw data for attributes and events together. You can choose the events that you will get, and choose the attributes that will be added to each event entry.

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 as follows to have access to the raw user data.

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

You can export raw user data in the following use-cases:

• To analyze user information using a business intelligence tool.
• 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 Insider team:

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

Sample Example

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' \
--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \
--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":"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' \
--header 'Cookie: __cfduid=d1a0bc0c8335c7fecbd3485839787329b1615112066' \
--data-raw '{
   "segment": {
        "segment_id": 123456789
    },
  "attributes": [
    "last_visited_product",
    "email",
    "name"
  ],
   "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":"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 that states if the request is successful or failed can be received via this API. No data can be inserted.
• The request token should be provided on the request header. If the token is incorrect, the operation will not be executed.
• The exported data can be in CSV, Parquet or JSON formats.
• The export link expires in 24 hours after it is ready.
• The rate limit is 1 request per day. The API can be called only once in 24 hours with respect to the UTC time zone. The limitation timeline resets at UTC 00:00.
• The value of X-PARTNER-NAME header should be lowercase.