report/demand-comparison/ad-units

Field and value reference · Markdown

curl -X GET "https://provisioning.cloudx.io/api/v1/report/demand-comparison/ad-units?start_time=1712462400&end_time=1713067200&demand_source=<demand_source>" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

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",
      "provider_business_id": "<string>",
      "provider_property_id": "<string>",
      "partner_ad_unit_id": "<string>",
      "partner_ad_unit_name": "<string>",
      "provider_endpoint": "<string>",
      "demand_type": "<string>",
      "partner_ad_formats": [
        "<string>"
      ],
      "cloudx_ad_unit_ids": [
        "<string>"
      ],
      "excluded_partner_revenue": 12.34,
      "excluded_partner_impressions": 12.34
    }
  ],
  "row_count": 123,
  "limit": 123,
  "truncated": true
}

Demand Comparison ad-unit reference

This endpoint rolls up the full requested calendar-date window for one partner source. It does not expose day, country, platform, mediator, or raw partner-report rows. Its date and timezone rules match the Demand Comparison summary endpoint.

demand_source is required and accepts exactly one of digitalturbine, inmobi, liftoff, meta, or moloco. provider_business_id, provider_property_id, and cloudx_ad_unit_id are optional comma-separated filters. They accept live provider or CloudX identifiers, not closed enums. Provider IDs identify the partner account or property. CloudX IDs identify CloudX ad units.

view is mapped or unmapped, and defaults to mapped. mapped returns partner ad-unit aggregates with a current CloudX mapping. unmapped returns partner rows with no current CloudX mapping or ambiguous attribution. limit is 1 through 1000 and defaults to 1000. The response has no pagination cursor. Use filters when truncated is true.

The response contains rows, row_count, limit, and truncated. row_count is the number of rows returned, not the total available. limit is the applied maximum. truncated is true when more matching rows exist.

Every row has these CloudX metrics:

The following partner and delta fields are numbers only when partner data is available for the row. An absent field means unavailable. It does not mean zero. Provider suppression can leave revenue unavailable even when report dates are covered. In the unmapped view, read excluded_partner_revenue and excluded_partner_impressions for excluded activity, not the mapped comparison metrics.

CloudX applies cloudx_ad_unit_id after forming a partner-ad-unit aggregate. If any associated ID matches, the response keeps the aggregate’s full metrics and complete cloudx_ad_unit_ids list.

JSON example

{
  "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",
      "provider_business_id": "business-demo",
      "provider_property_id": "property-demo",
      "partner_ad_unit_id": "partner-unit-demo",
      "partner_ad_unit_name": "Sample banner",
      "provider_endpoint": "meta",
      "demand_type": "standard",
      "partner_ad_formats": [],
      "cloudx_ad_unit_ids": ["ad-unit-home"]
    }
  ],
  "row_count": 1,
  "limit": 1000,
  "truncated": false
}