report/ab-test

GET/report/ab-test

Fetch A/B test metrics split by control and test variants. Requires the reports:read permission.

Request

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

Query parameters

NameTypeDescription
timezonestringIANA timezone for calendar buckets. Defaults to UTC. start_time and end_time remain absolute Unix timestamps and are never shifted. SDK reports, hourly dashboard/breakdown reports, and breakdowns grouped by bidder require whole-hour timezone offsets throughout the requested window because of hourly data and bucketing limitations. A/B reports support UTC only because they use saved UTC-day totals.
ab_test_idrequiredstringA/B test ID to report.
start_timerequiredinteger<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_timerequiredinteger<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.

Responses

A/B test metrics split by variant.
{
  "control": {
    "daily": [
      {
        "date": "2026-03-01",
        "revenue": 12.34,
        "impressions": 123,
        "requests": 123,
        "ecpm": 12.34,
        "fill_rate": 12.34,
        "dau": 123
      }
    ],
    "cumulative": {
      "revenue": 12.34,
      "impressions": 123,
      "requests": 123,
      "ecpm": 12.34,
      "fill_rate": 12.34
    }
  },
  "test": {
    "daily": [
      {
        "date": "2026-03-01",
        "revenue": 12.34,
        "impressions": 123,
        "requests": 123,
        "ecpm": 12.34,
        "fill_rate": 12.34,
        "dau": 123
      }
    ],
    "cumulative": {
      "revenue": 12.34,
      "impressions": 123,
      "requests": 123,
      "ecpm": 12.34,
      "fill_rate": 12.34
    }
  },
  "status": "<string>",
  "lift": 12.34,
  "ci_low": 12.34,
  "ci_high": 12.34,
  "p_value": 12.34,
  "n_control": 123,
  "n_test": 123,
  "required_n": 123,
  "chi_squared_p": 12.34
}

200A/B test metrics split by variant.

FieldTypeDescription
controlrequiredobject
testrequiredobject
statusstringLatest snapshot status (in_progress, directional, achieved, invalidated).
liftnumber<double>
ci_lownumber<double>
ci_highnumber<double>
p_valuenumber<double>
n_controlinteger<int64>
n_testinteger<int64>
required_ninteger<int64>
chi_squared_pnumber<double>

400Invalid request parameters.

FieldTypeDescription
errorrequiredstring

401Unauthorized.

FieldTypeDescription
errorrequiredstring

403Forbidden.

FieldTypeDescription
errorrequiredstring

500Internal server error.

FieldTypeDescription
errorrequiredstring

504The query did not finish within the request time budget. Retry, narrowing the time range or filters where the operation accepts them.

FieldTypeDescription
errorrequiredstring