高度なパフォーマンスレポート

status を変更するには Token を使用する必要があります。詳細は Token を確認してください。

この章では Advanced Performance Reporting API について説明します。

Report Data Retrieval Timing Guidelines

Data Update Rules:

• Hourly Data: 通常、処理に 2〜3 時間かかります。
• Daily Data (T+1): 通常、処理に 2〜4 時間かかります。

Recommended Retrieval Times:

• Hourly Data: 対象時刻の 2.5 時間後以降に取得することをおすすめします。
• Daily Data: 翌日 03:00 以降に取得することをおすすめします。

Examples:

• Jan 1, 10:00:00–10:59:59 のデータを取得する場合 → 推奨時刻: Jan 1 の 12:30 以降。
• Jan 1 の full-day data を取得する場合 → 推奨時刻: Jan 2 の 03:00 以降。

dimension_option parameter を調整することで、特定の dimensions を query できます。この interface の呼び出しは 2 つの手順に分かれます。

1. まず parameter type = 1 を設定して interface を呼び出します。システムは server 上で非同期に data を生成します。
   interface が code = 200 を返すと、data は正常に生成されています。

1.1 request 後、data が生成されるまで待つ必要があります。type = 1 で同じ request を継続して行うことで（Token は更新が必要）、data generation information を取得できます。

1.2 interface が code=200 を返すと、data が正常に生成されたことを意味します。

1.3 当日の data を取得する場合、data は不完全な可能性があります。data は hourly basis で更新されるため、data が準備されるまで n 時間待ち、その後 type=1 で再 request して data を更新し、より新しい data generation information を取得したうえで、type=2 を使用して data を更新するか判断できます。

1.4 data generation information については Response(type=1) を参照してください。

2. data が生成された後、parameter type = 2 を設定して interface を再度呼び出し、data を直接ダウンロードします。

2.1 data がまだ生成されていない場合、type = 2 interface の呼び出しは 200 以外の code を返します。

2.2 data が生成済みの場合、type = 2 interface は file byte stream（Content-Type: application / octet-stream）を直接返します。

2.3 data は "\t" で columns、"\n" で rows に区切られます。

2.4 返される data は current request の complete data であり、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
  }
}