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>'
{
  "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.