Skip to main content
GET
/
api
/
svc
/
v1
/
metrics
/
{workspaceId}
/
charts
List metric charts for an application
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts', 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://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts",
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://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts"

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))

}
HttpResponse<String> response = Unirest.get("https://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{controlPlaneURL}/api/svc/v1/metrics/{workspaceId}/charts")

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
{
  "step": "30s",
  "graphs": [
    {
      "name": "<string>",
      "description": "<string>",
      "chart": "<string>",
      "params": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Query Parameters

applicationId
string
required

Unique identifier of the application.

startTs
string | null

Start timestamp in milliseconds since epoch. Defaults to the application's last deployment creation time.

endTs
string | null

End timestamp in milliseconds since epoch. Defaults to the current time.

filterEntity
enum<string>
required

Scope of the chart bundle to return.

Available options:
application,
pod,
job-run,
event,
cluster
filterQuery
string | null

JSON-encoded filter required by certain scopes.

Example:

"{\"pod\":\"my-app-abc123-xyz\"}"

Response

Returns the list of metric charts available for the application.

step
string
required

Prometheus duration string for the query step size applied to the returned charts.

Example:

"30s"

graphs
Graph · object[]
required

List of available charts.