Creating a Data Export Task

Overview

The app server calls this API to create a data export task that exports all the data collected and reported by the app.

Scenario

If you need to import the data collected by Analytics Kit to your own analytics platform or a third-party analytics platform for analysis, you can use this API to export data that has been collected by Analytics Kit.

Restrictions

• A maximum of three concurrent data export tasks are supported for an app. When three export tasks are all being executed, new data export requests will not be processed. This means that a new data export request will be accepted only after some or all of the three export tasks are complete.
• The API can be called only once within 1 second.

API Prototype

Request Parameters

Request header

Request body

DateRange parameters

Filter parameters

Request Example

POST /analytics/export/raw_data_requests/v2 HTTP/1.1
Content-Type: application/json; charset=UTF-8
Accept: application/json
Authorization: Bearer *** 
x-product-id: sample-productid
x-app-id: sample-appid
 
{
    "date_range": {
        "start_date": "2020-03-10", 
        "end_date": "2020-03-17"
    }, 
    "file_format": "csv", 
    "filters": [
        {
            "name": "model", 
            "values": [
                "TL-00", 
                "MTA-00"
            ]
        }
    ]
}

Response Parameters

Assume that the status code is 200.

Response header

Response body

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Connection:  Close
Content-Length: xxxx                       
 
{
  "result_code":"0",
  "result_msg":"success",
  "request_id": "c0b41debe8064c54ab200d30907f40c5" 
}

Result Codes