report/demand-comparison
/report/demand-comparisonRequest
curl -X GET "https://provisioning.cloudx.io/api/v1/report/demand-comparison?start_time=1712462400&end_time=1713067200" \
-H "Authorization: Bearer $CLOUDX_API_KEY"Query parameters
| Name | Type | Description |
|---|---|---|
start_timerequired | integer<int64> | Start of the inclusive report window as a Unix timestamp in seconds. CloudX converts the timestamp to a calendar date in timezone. The start date must be 2020-01-01 or later. The window can span any number of completed calendar dates within available history; some dates may have no data. |
end_timerequired | integer<int64> | End of the inclusive report window as a Unix timestamp in seconds. CloudX converts the timestamp to a calendar date in timezone. The end date must not precede the start date and must be complete. At and after 12:00 UTC, yesterday is complete. Before 12:00 UTC, the most recent complete date is the day before yesterday. The window can span any number of completed calendar dates within available history; some dates may have no data. |
timezone | string | IANA timezone used to convert start_time and end_time to calendar dates. Defaults to UTC. |
demand_source | array of string | Optional demand-source filter. Repeat the parameter for each source, for example demand_source=meta&demand_source=moloco. Omit it to include all supported sources. Allowed values: digitalturbine, inmobi, liftoff, meta, moloco. |
provider_business_id | string | Optional provider-business filter. Use a comma-separated list for multiple values. |
provider_property_id | string | Optional provider-property filter. Use a comma-separated list for multiple values. |
cloudx_ad_unit_id | string | Optional CloudX ad-unit filter. Use a comma-separated list for multiple values. |
Responses
{
"rows": [
{
"cloudx_revenue": 12.34,
"partner_revenue": 12.34,
"revenue_delta": 12.34,
"revenue_delta_percent": 12.34,
"cloudx_ecpm": 12.34,
"partner_ecpm": 12.34,
"ecpm_delta": 12.34,
"ecpm_delta_percent": 12.34,
"cloudx_impressions": 12.34,
"partner_impressions": 12.34,
"impression_delta": 12.34,
"impression_delta_percent": 12.34,
"demand_source": "<string>",
"status": "comparable",
"matched_ad_units": 12.34,
"cloudx_ad_units": 12.34,
"has_mapping_gaps": true,
"partner_latest_report_date": "<string>",
"partner_report_days": 12.34
}
],
"row_count": 123
}200Mapped demand comparison summary.
| Field | Type | Description |
|---|---|---|
rowsrequired | array of object | |
row_countrequired | integer<int64> |
400Invalid request parameters.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
401Unauthorized.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
403Forbidden.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
500Internal server error.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
504The query did not finish within the request time budget. Retry, narrowing the time range or filters where the operation accepts them.
| Field | Type | Description |
|---|---|---|
errorrequired | string |
需求对比汇总参考
该端点按需求方来源汇总完整请求日历日期窗口。它不提供 day、country、platform、mediator 或原始需求方报表行。CloudX 确认值是 CloudX 报表事实。需求方值来自选定需求方报表。
start_time 和 end_time 是必填 Unix 秒。CloudX 在 timezone 中将每个时间戳转换成日历日期。timezone 是 IANA 时区,默认 UTC。转换后的窗口包含端点。起始日期不得早于 2020-01-01,结束日期不得早于起始日期。在可用历史数据范围内,可选择任意长度的已结束日历日期窗口。UTC 12:00 或之后,最近的已结束日期是昨天;UTC 12:00 之前是前天。时区转换只选择日期,不会重新分桶需求方事实。请求的日期可能没有 CloudX 或需求方数据。
demand_source 可选。省略时包含所有受支持来源,也可重复传入最多五个唯一值。完整枚举为 digitalturbine、inmobi、liftoff、meta 和 moloco。provider_business_id、provider_property_id 和 cloudx_ad_unit_id 是可选逗号分隔过滤器。它们接受实时需求方或 CloudX ID,不是封闭枚举。需求方 ID 标识需求方账号或资产。CloudX ID 标识 CloudX 广告单元。
响应包含 rows 和 row_count。row_count 是返回来源行数。每个受支持来源最多出现一次。
每一行都有以下 CloudX 指标:
| 字段 | 含义 |
|---|---|
cloudx_revenue | CloudX 确认的收入。 |
cloudx_ecpm | cloudx_revenue * 1000 / cloudx_impressions;展示数为零时为 0。 |
cloudx_impressions | CloudX 展示数。 |
下列需求方和差异字段只有在该行有需求方数据时才是数字。字段缺失表示不可用,不表示零。comparable 确认已映射报表日期覆盖请求窗口,不保证每个指标均可用。需求方可以隐藏低流量切片的收入。
| 字段 | 含义 |
|---|---|
partner_revenue | 需求方上报收入。 |
revenue_delta | cloudx_revenue - partner_revenue。 |
revenue_delta_percent | 收入差异占需求方收入的百分比。需求方收入低于 0.005 时缺失。 |
partner_ecpm | partner_revenue * 1000 / partner_impressions;展示数为零时为 0。需要两个需求方指标均可用。 |
ecpm_delta | cloudx_ecpm - partner_ecpm。 |
ecpm_delta_percent | eCPM 差异占需求方 eCPM 的百分比。需求方 eCPM 低于 0.005 时缺失。 |
partner_impressions | 需求方上报展示数。 |
impression_delta | cloudx_impressions - partner_impressions。 |
impression_delta_percent | 展示差异占需求方展示数的百分比。需求方展示数低于 1 时缺失。 |
| 字段 | 含义 |
|---|---|
demand_source | 一个受支持需求方来源枚举值。 |
status | comparable、not_connected、no_partner_data、unmapped_partner_data 或 stale_partner_data。comparable 的已映射需求方报表日期覆盖请求窗口。not_connected 没有活动需求方连接。no_partner_data 没有已映射需求方报表,且没有非零的未映射需求方收入或展示数。unmapped_partner_data 有非零的未映射需求方收入或展示数,但没有已映射需求方报表。stale_partner_data 未覆盖完整请求窗口。 |
matched_ad_units | CloudX 和需求方两侧均有正展示数的不同已映射需求方广告单元 ID 数。 |
cloudx_ad_units | 有正 CloudX 展示数的不同已映射需求方广告单元 ID 数,不是所有已配置 CloudX 广告单元的数量。 |
has_mapping_gaps | 缺失或不明确映射影响收入或展示数时为 true。 |
partner_latest_report_date | 可用时为最新已映射需求方报表日期,格式 YYYY-MM-DD。 |
partner_report_days | 请求窗口中不同的已映射需求方报表日期数。 |
JSON 示例
{
"rows": [{"cloudx_revenue": 14.25, "partner_revenue": 13.9, "revenue_delta": 0.35, "revenue_delta_percent": 2.5179856115107913, "cloudx_ecpm": 11.875, "partner_ecpm": 11.583333333333334, "ecpm_delta": 0.2916666666666661, "ecpm_delta_percent": 2.5179856115107864, "cloudx_impressions": 1200, "partner_impressions": 1200, "impression_delta": 0, "impression_delta_percent": 0, "demand_source": "meta", "status": "comparable", "matched_ad_units": 2, "cloudx_ad_units": 2, "has_mapping_gaps": false, "partner_latest_report_date": "2026-04-01", "partner_report_days": 1}],
"row_count": 1
}