Advanced Performance Reporting

You need to use the Token to change the status. For more details, please check Token.

This chapter will introduce Advanced Performance Reporting API.

Report Data Retrieval Timing Guidelines

Data Update Rules:

• Hourly Data: Typically takes 2–3 hours to process.
• Daily Data (T+1): Usually takes 2–4 hours to process.

Recommended Retrieval Times:

• Hourly Data: Suggest pulling 2.5 hours after the target time.
• Daily Data: Recommend retrieving after 03:00 the next day.

Examples:

• To retrieve data for Jan 1, 10:00:00–10:59:59 → Suggested time: After 12:30 on Jan 1.
• To retrieve full-day data for Jan 1 → Suggested time: After 02:30 on Jan 2.

You can adjust the dimension_option parameter to query specific dimensions.Calling this interface is divided into two steps:

1. First you need to set the parameter type = 1 and call the interface. The system will generate data asynchronously on the server.
   When the interface returns a code = 200, the data has been successfully generated.

1.1 After the request, you need to wait for the data to be generated. You can continue to make the same request with type = 1 (the Token needs to be updated) to get the data generation information.

1.2 When the interface returns code=200, it means the data has been successfully generated.

1.3 If you are retrieving the data for the current day, the data may be incomplete. The data is updated on an hourly basis, so you can wait for n hours until the data is ready, then re-request with type=1 to update data and get the newer data generation information, and then determine whether to use type=2 to update the data.

1.4 Refer to Response(type=1) for the data generation information.

2. After the data is generated, set the parameter type = 2 and call the interface again to download the data directly.

2.1 If the data has not been generated, calling the type = 2 interface will return a code other than 200.

2.2 If the data has been generated, using the type = 2 interface will directly return the file byte stream (Content-Type: application / octet-stream).

2.3 The data is separated by "\t" as columns and "\n" as rows.

2.4 The returned data is the complete data for the current request, not just the incremental data.

Request address

https://ss-api.mintegral.com/api/v2/reports/data

Request method

GET

Request example

GET /api/v2/reports/data?start_time=2024-06-01&end_time=2024-06-01&type=1&dimension_option=Offer
HTTP/1.1 Host: ss-api.mintegral.com

Request Parameter

The file headers (fields) returned(type=2)

Response(type=1)

Response(type=2 and return code is not 200)

Response Example

{
  "code": 200,
  "msg": "success",
  "data": {
    "hours": 24,
    "is_complete": true
  }
}