Export survey results with raw user data

Overview

Export Raw User Data API prepares the raw data for events and attributes together, and also allows you to export App Survey results for multiple requested events and attributes of a user (e.g. name, phone number, age, city, etc.) into Insider's AWS S3 bucket. The request returns a link to partner's webhook endpoint, and this link enables you to have access to the raw user data and transfer it to your end.

When a user answers a survey question and submits their response, this action triggers the survey_result event along with its camp ID, variant ID, question, answer, and timestamp event parameters. This event and its parameters can be listed on the respective user's User Profile.

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:

• Analyze user information using a business intelligence tool.
• Sync the data that you want via daily jobs.
• Get detailed insights about users who submit responses on surveys.

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 survey results with raw user data (e.g. attributes such as insider ID(iid), unique device ID (udid), phone number(pn), unique user ID (uuid), email (em), app version, model (mo), and device software version (ov)).

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":[
        "iid",
        "udid",
        "pn",
        "uuid",
        "em",
        "app_version",
        "mo",
        "ov"
    ],
   "events":{
      "start_date":1606311893,
      "end_date":1611582293,
      "wanted":[
         {
            "event_name":"survey_result",
            "params":[
               "timestamp",
               "answer",
               "camp_id",
               "question",
               "variant_id"
            ]
         }
      ]
   },
   "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.