# 报告 API

> 通过对 LevelPlay 广告服务报告 API 的过滤 GET 调用，跨广告格式和维度检索 Monetization 数据。

> **Important:**
>
> 以前的 API 版本将于 2025 年 8 月 15 日弃用。在此截止日期之前更新到最新版本，以便不间断提供服务。

使用此 API 可从 LevelPlay 和/或 ironSource 广告服务提供的 Monetization 广告格式接收所有报告数据。这包括多个指标，例如收入、展示量、激活用户等，涵盖多个细分和可选过滤器。

> **Note:**
>
> Reporting API 限制为每 1 小时 8,000 个请求。

### Authentication类型

[Bearer API 身份验证](/grow/levelplay/platform/api/authentication.md.md)

### 方法

`GET` [https://platform.ironsrc.com/levelPlay/reporting/v1](https://platform.ironsrc.com/levelPlay/reporting/v1)

### 必需参数

| Name（名称）    | Type（类型） | 描述                 | Default |
| ----------- | -------- | ------------------ | ------- |
| `startDate` | 字符串      | YYYY-MM-DD（UTC 时区） | *       |
| `endDate`   | 字符串      | YYYY-MM-DD（UTC 时区） | -       |

### 可选参数

使用 ironSource 广告服务报告 API 时，可按任意一个可选参数过滤报告。这使您能够搜索与任何过滤器的直接匹配。

| Name（名称）               | Type（类型）   | 描述                                                                                                                 | Default   |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | --------- |
| `appKey`               | 字符串（以逗号分隔） | 应用程序密钥（在 LevelPlay 和 ironSource 广告服务平台上可见）                                                                         | 所有 app 密钥 |
| `country`              | 字符串（以逗号分隔） | 双字母国家/地区代码。请参阅 [ISO 3166-1 Alpha-2](http://www.iso.org/iso/country_names_and_code_elements)。                       | 所有国家/地区   |
| `adFormat`             | 字符串        | * `rewarded`
* `offerwall`
* `interstitial`
* `banner`                                                             | 所有广告格式    |
| `adNetwork`            | 字符串（以逗号分隔） | 聚合广告网络，包括 IronSource 广告服务。请参阅 [LevelPlay API 命名和配置](/grow/levelplay/platform/api/naming-and-configurations.md.md)。 | 所有广告源     |
| `isLevelPlayMediation` | 字符串（布尔值）   | 从 2024 年 3 月 1 日起支持。仅与 ironSource 广告服务网络相关。选项为：* `true`
* `false`                                                  | 全部        |
| `isBidder`             | 字符串（布尔值）   | 选项为：* `true`
* `false`                                                                                             | 全部        |
| `platform`             | 字符串        | 选项为：* `android`
* `ios`                                                                                            | 全部        |
| `abTest`               | 字符串        | 选项为：* `A`
* `B`
* `NULL`
预期单个值                                                                                 | 全部        |
| `mediationGroup`       | 字符串（以逗号分隔） | 聚合组（在 LevelPlay 平台上显示）                                                                                             | 所有组       |
| `mediationAdUnitId`    | 字符串（以逗号分隔） | 产生收入的广告单元的 ID                                                                                                      | 所有聚合广告单位  |
| `metrics`              | 字符串（以逗号分隔） | 请参阅[支持的指标](#supported-metrics)部分。                                                                                  | 所有指标      |
| `breakdowns`           | 字符串（以逗号分隔） | 请参阅[支持的细分](#supported-breakdowns)部分。                                                                               | date      |
| `page`                 | 数字         | 要显示的页码                                                                                                             | 1         |
| `resultsPerPage`       | 数字         | 要为每个页面显示的结果数                                                                                                       | 5000      |

### 支持的细分

* 日期(天)/周/月。
* app
* platform
* adNetwork
* isBidder
* adFormat
* 实例
* country
* mediationGroup
* mediationAdUnit
* 细分段 (Segment)：
* placement
* osVersion
* sdkVersion
* appVersion
* att
* idfa
* 盖德
* abTest
* isLevelPlayMediation
* bannerSize

> **Note:**
>
> 如果未指定时间段，则返回的数据不会按指定的时间段中断，而是请求指标中的所有历史数据。

### 支持的指标

* 收入
* impressions
* eCPM
* 点击
* clickThroughRate
* 会话
* engagedSessions
* impressionPerEngagedSessions
* impressionsPerSession
* activeUsers
* revenuePerActiveUser
* sessionsPerActiveUser
* impressionsPerActiveUser
* engagedUsers
* revenuePerEngagedUser
* impressionsPerEngagedUser
* engagedUsersRate
* appFills
* appFillRate
* useRate
* appRequests
* 完成
* completionRateImpBased
* revenuePerCompletion
* adSourceChecks
* adSourceResponses
* adSourceAvailabilityRate

### 细分限制

以下故障的任何组合都会导致验证报错：

* 实例
* 细分段 (Segment)：
* placement
* bannerSize
* 伊德法
* 盖德
* 阿特
* appVersion
* SdkVersion
* osVersion

### 请求示例网址

```xml
https://platform.ironsrc.com/levelPlay/reporting/v1?startDate=2024-12-01&endDate=2024-12-02&metrics=revenue,impressions,activeUsers&breakdowns=date,adFormat&adFormat=rewarded

```

#### JSON 响应示例

```json
{
  "data": [
    {
      "date":"2024-12-01",
      "adFormat":Rewarded（奖励广告）：
      "revenue":96891.75,
      "impressions":12186156,
      "activeUsers":13310891
    },
    {
      "date":"2024-12-01",
      "adFormat":Rewarded（奖励广告）：
      "revenue":101385.59,
      "impressions":12478225,
      "activeUsers":13586039
    },
    {
      "date":"2024-12-02",
      "adFormat":Rewarded（奖励广告）：
      "revenue":117979.71,
      "impressions":13440354,
      "activeUsers":14540198
    }
  ],
  "page":1,
  "pageSize":3,
  "totalResults":10
}
```