Reports

Create a new report request.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestringRequiredExample: 2023 GPU report

startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07 12:09:18.211

endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07 12:09:18.211

groupBystring · enum · nullableOptionalPossible values:

filterBystring[]Optional

Filter results by a parameter. Use the format field-name == value.

Default: []Example: ["projectName==some-name"]

Responses

202

Accepted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

post

/api/v1/org-unit/reports

HTTPcURLJavaScriptPython

POST /api/v1/org-unit/reports HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ]
}

{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-04-03T11:51:29.332Z",
  "createdBy": "[email protected]",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-04-03T11:51:29.332Z",
  "statusMessage": "Report in queue"
}

Get report

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383

Responses

200

Executed successfully.

application/json

namestringRequiredExample: 2023 GPU report

startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07 12:09:18.211

endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07 12:09:18.211

groupBystring · enum · nullableOptionalPossible values:

filterBystring[]Optional

Filter results by a parameter. Use the format field-name == value.

Default: []Example: ["projectName==some-name"]

idstring · uuidRequired

createdAtstring · date-timeRequired

createdBystringRequiredExample: [email protected]

tenantIdinteger · int32Required

ID of the tenant where the project is located.

Example: 2

statusstring · enumRequiredPossible values:

statusUpdatedAtstring · date-timeRequired

statusMessagestringOptionalExample: Report in queue

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/reports/{reportId}

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/reports/{reportId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-04-03T11:51:29.332Z",
  "createdBy": "[email protected]",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-04-03T11:51:29.332Z",
  "statusMessage": "Report in queue"
}

Delete report

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383

Responses

204

No Content.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

delete

/api/v1/org-unit/reports/{reportId}

HTTPcURLJavaScriptPython

DELETE /api/v1/org-unit/reports/{reportId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download report

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383

Responses

200

Executed successfully.

text/csv

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/reports/{reportId}/file

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/reports/{reportId}/file HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*