report/ad-units

GET/report/ad-units

Fetch per-ad-unit performance for the requested time range. Requires the reports:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/report/ad-units?start_time=1712448000&end_time=1712534399" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

Name	Type	Description
`start_time`required	`integer<int64>`	Start of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days and must not start before 2020-01-01 UTC.
`end_time`required	`integer<int64>`	End of the time range as a Unix timestamp in seconds. The requested range must not exceed 31 days and must not end before 2020-01-01 UTC.
`test_mode`	`string`	Traffic mode to include. Defaults to production traffic.
`app_bundle`	`string`	App bundle identifier filter.
`ad_unit_type`	`string`	Ad unit format filter.
`country`	`string`	ISO 3166-1 alpha-2 country code filter.
`device_os`	`string`	Device operating system filter.
`source`	`string`	Reporting source filter. Use `cloudx`, a mediation source such as `applovin`, a comma-separated list such as `cloudx,admob`, or `all`.

Responses

Ad unit performance data.

{
  "ad_units": [
    {
      "ad_unit_id": "<string>",
      "name": "<string>",
      "app_name": "<string>",
      "app_bundle": "<string>",
      "type": "<string>",
      "revenue": 12.34,
      "impressions": 123,
      "fill_rate": 12.34,
      "ecpm": 12.34,
      "source": "<string>",
      "revenue_share": 12.34
    }
  ]
}

200 Ad unit performance data.

Field	Type	Description
`ad_units`required	`array of object`

400 Invalid request parameters.

Field	Type	Description
`error`required	`string`

401 Unauthorized.

Field	Type	Description
`error`required	`string`

403 Forbidden.

Field	Type	Description
`error`required	`string`

500 Internal server error.

Field	Type	Description
`error`required	`string`