Skip to navigation
REST APIOrganizationsProjects

Get projects telemetry

View as Markdown
Get projects telemetry data by the given query parameters

Authentication

AuthorizationBearer
Bearer authentication

Query parameters

clusterIdstringOptionalformat: "uuid"

Filter using the Universally Unique Identifier (UUID) of the cluster.

nodepoolIdstringOptional
Filter using the nodepool.
departmentIdstringOptional
Filter using the department id.
projectIdstringOptional
project id to filter by
groupBylist of enumsOptional
project fields to group the data by
Allowed values:
telemetryTypeenumRequired
specifies what data to request

Response

Executed successfully.
typestring
specifies what data returned
timestampdatetime
valueslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error