Skip to content
TestLookupTestLookup
Search Ctrl K

Search TestLookup

Enter a term to search the local static index.

    Chart Data — GET /api/v1/analytics/chart-data

    Chart Data

    A metric over up to two dimensions, as contract C3 chart_series.

    Endpoint: GET /api/v1/analytics/chart-data

    Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.

    Parameters

    Section titled “Parameters”
    NameInRequiredTypeDefaultDescription
    metricquerynostringexecutionsWhat to measure. One of: broken, duration_p50, duration_p95, duration_total, executions, failed, failure_rate, failures, flaky_tests, pass_rate, passed, retried_tests, run_count, skipped, unique_tests, unknown, wall_clock_p50, wall_clock_p95, wall_clock_total
    group_byquerynoarray of string or nullThe axis, and optionally a second dimension to key the series by (at most two, the time dimension first). One of: branch, day, environment, failure_category, ingestion_source, project, release, status, suite, test, week
    top_nquerynointeger or nullKeep the largest N keys and merge the rest into an ‘other’ bucket. Required for group_by=test outside a single suite.
    facet_dimensionquerynostring or nullWith facet_value: draw one panel of a small multiple, counting only the executions whose value of this dimension is facet_value. One of: branch, environment, status, failure_category, ingestion_source. run_count with status or failure_category is refused (facet_metric_grain).
    facet_valuequerynostring or nullThe panel’s KEY as the chart buckets it (a branch, an environment lower-cased, a status of passed/failed/broken/skipped/unknown, a failure category lower-cased, an ingestion source). Sent with facet_dimension.
    project_idquerynostring or nullOne project (single-valued). Omit for every project you can read.
    release_idquerynoarray of string or nullRepeatable (OR, at most 20): a release UUID or ‘unattributed’ for runs no release claims.
    suite_namequerynoarray of string or nullRepeatable (OR, at most 50), 1-500 characters; matched case-insensitively on the effective suite.
    daysquerynointeger30Window in days, 1-365.
    X-API-Keyheadernostring or nullAPI key, as an alternative to the access token (see Authentication).

    Request body

    Section titled “Request body”

    No request body.

    Responses

    Section titled “Responses”
    StatusMeaningBody
    200Successful ResponseNot documented (application/json)
    422Validation ErrorHTTPValidationError (application/json)

    Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.

    It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.

    More details

    Section titled “More details”