Get an app's request and cost breakdown over time

curl --request GET \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cost_totals": {},
  "costs": {},
  "end_date": "<string>",
  "interval": "<string>",
  "request_totals": {},
  "requests": {},
  "start_date": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

projects

{project_id}

apps

{app_id}

dashboard-metrics

Get an app's request and cost breakdown over time

curl --request GET \
  --url https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://rest.cerebrium.ai/v2/projects/{project_id}/apps/{app_id}/dashboard-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "cost_totals": {},
  "costs": {},
  "end_date": "<string>",
  "interval": "<string>",
  "request_totals": {},
  "requests": {},
  "start_date": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Service Account Token authentication. To authenticate API requests:

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
Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>
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

month

string

Report on a whole billing month, in UTC. One of current or previous; defaults to current. Ignored when start and end are supplied. A billing month is longer than the minute and hour intervals allow, so those require start and end.

start

string

Start of an arbitrary period, RFC3339. Takes precedence over month, and must be sent with end. Cannot be more than 180 days ago.

end

string

End of an arbitrary period, RFC3339. Takes precedence over month, and must be sent with start.

interval

string

Bucket size to group the series by: minute, hour, day (default) or month. Each caps how long a period you can ask for — 6 hours for minute, 7 days for hour, 180 days for day and month — and a longer one is rejected with a 400. Because a billing month is longer than the minute and hour caps, those intervals must be paired with start and end rather than month.

string

IANA timezone the buckets fall in, e.g. America/New_York. Defaults to UTC. Month and day buckets start at midnight in this zone, and minute and hour buckets on its minute or hour — which is not the UTC hour in zones offset by 30 or 45 minutes, such as Asia/Kolkata.

Response

Two zero-filled time series covering the whole period — requests by response status and cost by resource — plus a total for each. Both series are objects keyed by bucket start, in ascending key order.

cost_totals

object

Spend for the whole period, same fields as a costs entry. Equal to the sum of the buckets.

costs

object

Spend per bucket in fractional cents, split into gpu_cost_cents, cpu_cost_cents and memory_cost_cents alongside total_cost_cents, with total_running_time_ms for the container time that spend covers. Note the key format differs from requests: month and day buckets are keyed YYYY-MM-DD (a month by its first day), minute and hour buckets RFC3339. unique_container_count is not populated.

end_date

string

End of the period actually reported on, RFC3339. Echoes end, or the last moment of the billing month when month was used.

interval

string

Bucket size the series were grouped by, echoing the interval requested: minute, hour, day or month.

request_totals

object

Request counts for the whole period, same fields as a requests entry. Equal to the sum of the buckets.

requests

object

Request counts per bucket, keyed by bucket start in RFC3339. Month and day buckets fall at midnight in tz; minute and hour buckets are instants expressed in UTC. Each value splits total into 2xx, 4xx, 5xx, websocket_success (close codes 1000-1001), websocket_error (1002-1999), and other (anything outside those ranges, including no status).

start_date

string

Start of the period actually reported on, RFC3339. Echoes start, or the first moment of the billing month when month was used.

⌘I

Builds

Projects

API Keys

Apps

Containers

Metrics

Runs

Secrets

Billing

Custom Domains

Subscriptions

Service Accounts

Users

Volumes

Files

Cerebrium Run

Integrations

Get an app's request and cost breakdown over time

Authorizations

Path Parameters

Query Parameters

Response