Skip to main content
GET
Get Runs Chart Data

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account

  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required
app_id
string
required

Query Parameters

startDate
string
required

Start of the time range, in RFC3339 format.

endDate
string
required

End of the time range, in RFC3339 format.

limit
integer

Maximum number of individual runs to return when not aggregating. Must be > 0. Default: 100.

offset
integer

Number of runs to skip when not aggregating. Must be >= 0. Default: 0.

status
string

Filter runs by status. Valid values: pending, proxyQueued, containerQueued, processing, success, failure, cancelled.

statusCode
string

Filter runs by status code. Digits pin their position and the first 'x' frees the rest, so 201 is exactly 201, 20 is 200-209 and 4xx is 400-499. A four-digit value is an exact websocket close code, e.g. 1000.

region
string

Filter runs by region.

groupBy
string

Time bucket for aggregated results. Valid values: minute, hour, day.

aggregate
boolean

Set to true to return aggregated counts instead of individual runs. Time ranges longer than 24 hours are aggregated automatically.

minStartupTimeMs
integer

Only include runs with a startup time of at least this many milliseconds.

maxStartupTimeMs
integer

Only include runs with a startup time of at most this many milliseconds.

minResponseTimeMs
integer

Only include runs with a response time of at least this many milliseconds.

maxResponseTimeMs
integer

Only include runs with a response time of at most this many milliseconds.

tz
string

IANA timezone used for time bucketing (e.g. America/New_York). Default: UTC.

Response

Run data for charting, either individual runs or aggregated time buckets.

aggregatedData
array

Aggregated counts per time bucket, when aggregating. Each item includes timeGroup, startTime, endTime, request counts (totalRequests, successfulRequests, failedRequests, cancelledRequests, proxyQueued, containerQueued, processing), successRate (number), and timing statistics in milliseconds (avg, p50, p90, p99, min, and max for runtime and response time, plus avgColdstartTimeMs and avgQueueTimeMs). Omitted when not aggregating.

groupBy
string

The time bucket size used for aggregation. Omitted when not aggregating.

items
array

Individual runs, when not aggregating. Each item has id, projectId, modelId, podName, coldstartTimeMs (integer), totalQueueTimeMs (integer), runtimeMs (number), totalResponseTimeMs (number), statusCode (integer), createdAt, and updatedAt fields. Omitted when aggregating.

nextToken
string

Pagination token for the next page. Omitted when there are no more results.

timeRange
string

The time range covered by the aggregated results. Omitted when not aggregating.

total
integer

Total number of runs matching the query.