Documentation Index
Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt
Use this file to discover all available pages before exploring further.
Tool Reference
CloudX MCP currently exposes six public tools: five reporting tools and one documentation search tool.
| Tool | Purpose | Extra Filters | Main Response Fields |
|---|
GetReportDashboard | Summary KPIs plus chart data | test_mode, country, device_os | summary, chart_data |
GetReportBidders | Bidder-level performance | test_mode, country, device_os | bidders |
GetReportApps | App-level performance | test_mode, country, device_os | apps |
GetReportAdUnits | Ad unit-level performance | test_mode, country, device_os, app_bundle, ad_unit_type | ad_units |
GetReportExport | Raw export rows in JSON shape | country, device_os | columns, rows, row_count |
SearchDocs | CloudX documentation search | none | results |
| Parameter | Required | Supported By | Notes |
|---|
start_time | Yes | Reporting tools | Unix timestamp in seconds, UTC |
end_time | Yes | Reporting tools | Unix timestamp in seconds, UTC |
country | No | Reporting tools | ISO-2 country code |
device_os | No | Reporting tools | iOS or Android |
test_mode | No | Dashboard, Bidders, Apps, Ad Units | production, test, or all |
app_bundle | No | Ad Units only | Bundle ID such as com.example.game |
ad_unit_type | No | Ad Units only | BANNER, INTERSTITIAL, REWARDED, MREC, or NATIVE |
GetReportDashboard
Use this tool for top-line reporting across a time range.
Best For
- total revenue and fill rate checks
- daily trend analysis
- quick health checks by country or platform
Parameters
| Parameter | Type | Required |
|---|
start_time | integer | Yes |
end_time | integer | Yes |
country | string | No |
device_os | string | No |
test_mode | string | No |
Response Shape
summary includes fields such as total_requests, total_impressions, revenue, fill_rate, ecpm, total_clicks, ctr, and total_users.
GetReportBidders
Use this tool when you want to compare demand partners.
Best For
- finding the highest-revenue bidder
- checking bid rate and win rate by partner
- comparing supply quality across countries or platforms
Parameters
| Parameter | Type | Required |
|---|
start_time | integer | Yes |
end_time | integer | Yes |
country | string | No |
device_os | string | No |
test_mode | string | No |
Response Shape
Each bidder row can include name, requests, bids, bid_rate, impressions, win_rate, revenue, and ecpm.
GetReportApps
Use this tool to compare app-level performance within an account.
Best For
- ranking apps by revenue
- comparing iOS and Android portfolio performance
- spotting low fill-rate apps
Parameters
| Parameter | Type | Required |
|---|
start_time | integer | Yes |
end_time | integer | Yes |
country | string | No |
device_os | string | No |
test_mode | string | No |
Response Shape
Each app row can include app_id, name, platform, impressions, fill_rate, revenue, and ecpm.
GetReportAdUnits
Use this tool for placement-level investigation.
Best For
- comparing banners vs rewarded vs interstitial
- isolating a single app bundle
- finding weak or high-value ad placements
Parameters
| Parameter | Type | Required |
|---|
start_time | integer | Yes |
end_time | integer | Yes |
country | string | No |
device_os | string | No |
test_mode | string | No |
app_bundle | string | No |
ad_unit_type | string | No |
Response Shape
Each row can include ad_unit_id, name, app_name, app_bundle, type, impressions, fill_rate, revenue, and ecpm.
GetReportExport
Use this tool when you need tabular data rather than a summarized report.
Best For
- passing data into spreadsheets
- validating downstream analytics
- handing structured rows to another tool or agent
Parameters
| Parameter | Type | Required |
|---|
start_time | integer | Yes |
end_time | integer | Yes |
country | string | No |
device_os | string | No |
Response Shape
SearchDocs
Use this tool to search CloudX documentation from an MCP client before answering setup, configuration, SDK, CLI, dashboard, network, or reporting questions.
Best For
- finding the right documentation page for a CloudX workflow
- grounding an answer in current docs before explaining a feature
- retrieving relevant setup or troubleshooting snippets without leaving the AI client
Parameters
| Parameter | Type | Required | Notes |
|---|
body.query | string | Yes | Natural-language search query |
{
"name": "SearchDocs",
"arguments": {
"body": {
"query": "report filters"
}
}
}
Response Shape
Each result includes:
content: matching documentation snippetpath: documentation path such as /en/cli/reportingurl: absolute docs URLmetadata: page metadata such as title, when available
Error Behavior
These tools return MCP error results when the request cannot be fulfilled. Common reporting causes:
- missing
start_time or end_time
- invalid enum values such as
device_os: "ios" instead of iOS
- backend validation errors for the selected account or time range
For SearchDocs, a blank or missing query returns query is required. If documentation search is temporarily unavailable, the tool returns a docs search error.
