CloudX API

Authenticate requests and use the CloudX API reference.

CloudX API

Use the CloudX API to retrieve reporting metrics, inspect auctions, manage Tasks, and read or write account configuration.

Base URL

https://provisioning.cloudx.io/api/v1

Authentication

Create an API key in Settings > API Keys, then send it as a bearer token:

curl https://provisioning.cloudx.io/api/v1/auth/status \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Only administrators can create, manage, and revoke API keys.

Permissions

Choose permissions based on the endpoints your integration needs.

Permission	Allows
`reports:read`	Reporting and activity-export endpoints under `/report/` and `/export/`
`auctions:read`	Auction inspection endpoints under `/auction/*`
`configuration:read`	Configuration endpoints under `/config/*` and Task read endpoints
`configuration:write`	Configuration write endpoints under `/config/*` and Task write endpoints

Use GET /report/network to read the daily reports from your Digital Turbine, InMobi, Liftoff, Meta, and Moloco data source connections. Break results down by day, network, app, country, platform, format, or placement, filter on exact values, and page through JSON or CSV output.

Unity Ads

Connect Unity Ads in Data Sources settings to compare Unity’s reporting with CloudX in Demand Comparison. GET /report/network does not return Unity Ads data yet.

CloudX asks for four values from your Unity Monetization dashboard:

Field	Where to find it in Unity
Organization ID	Organization settings → Organization core ID. The page shows two organization IDs. Use the core ID.
Stats API key	API management → Monetization Stats API Access. If there is no key, select Create API key.
Key ID	The key of a service account. See the steps below.
Secret key	Created with the Key ID. Unity shows it only once.

To create the service account, you must be an Owner or Manager of the Unity organization:

Open Settings → Organization → Manage organization → Service accounts and select + New. Some dashboard versions show Service accounts under Administration.
On the service account page, go to Organization roles and select + Manage organization roles. In the Monetization list, add Monetize Projects Viewer.
In Keys, select + Add key. Copy the Key ID and the Secret key.

CloudX only reads your Unity reporting, projects, and placements, so the service account needs no editor or admin role. It does need the role from step 2. Without it, CloudX shows These keys can’t read this Unity organization’s reporting and projects when you save.

After you save, CloudX syncs the last 30 days of Unity reporting, then syncs again every day.

Activity Exports

Create asynchronous, full-day activity-export reports with POST /export/impressions, POST /export/requests, or POST /export/bids, then poll the matching GET endpoint until the export is ready.

Most reports are ready to download within 5–45 minutes. Processing time varies with the amount of data for the selected date and filters. When the export is ready, the status response includes a short-lived download URL.

See Activity Exports for request bodies, polling examples, and the CSV schemas returned by both the API and CLI.

Configuration Writes

Use POST /config/edit to create or update a config draft for apps, ad units, ad unit groups, lists, tags, test devices, network mappings, and line items. The same endpoint also accepts A/B test operations; creating an A/B test returns a draft, while update, start, end, promote, and delete publish the resulting config.

Requests use typed operation keys such as create_app, update_ad_unit, upsert_network_mapping, and update_line_item. Set price floors on line items; ad-unit create and update operations do not accept bidfloor. Line-item bidfloor values are decimal USD CPM, so 1.5 means $1.50 CPM.

Tasks

Use the /scheduled-agents endpoints to manage recurring CloudX analyses. The API uses scheduled-agents in endpoint paths for compatibility, but the product and CLI call them Tasks.

Create a Task with a prompt and five-field cron schedule:

curl https://provisioning.cloudx.io/api/v1/scheduled-agents \
  -X POST \
  -H "Authorization: Bearer $CLOUDX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly revenue review",
    "prompt": "Review weekly revenue and flag material changes",
    "schedule": "0 9 * * 1",
    "timezone": "Europe/Madrid",
    "access_mode": "workspace"
  }'

The Task endpoints support the full lifecycle:

Method	Endpoint	Action
`GET`	`/scheduled-agents`	List Tasks.
`POST`	`/scheduled-agents`	Create a Task.
`GET`	`/scheduled-agents/{scheduled_agent_id}`	Get one Task.
`PATCH`	`/scheduled-agents/{scheduled_agent_id}`	Update one or more fields.
`DELETE`	`/scheduled-agents/{scheduled_agent_id}`	Delete a Task.
`POST`	`/scheduled-agents/{scheduled_agent_id}/run`	Queue an enabled Task now.

Read operations require configuration:read; mutations require configuration:write. User-authenticated mutations also require editor access. The Tasks feature must be available for the account.

Set access_mode to private or workspace. Private Tasks require an end-user creator and are visible only to that user. Tasks created with an API key have no end-user creator, are workspace-visible, and cannot be made private.

Task responses include the cron expression, IANA timezone, human-readable schedule, enabled state, access mode, optional creator user ID, next run time, timestamps, and creation source.

API Reference

The API reference is generated from the live OpenAPI schema hosted by CloudX.