Reports

List reports

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["name!=some-name"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/reports

HTTPcURLJavaScriptPython

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

{
  "reports": [
    {
      "name": "2023 GPU report",
      "description": "This report shows the GPU usage of all projects in the organization",
      "start": "2023-06-07T09:09:18.211Z",
      "end": "2023-06-07T12:09:18.211Z",
      "groupBy": "Nodepool",
      "filterBy": [
        "projectName==some-name"
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-02-05T00:00:47.223Z",
      "createdBy": "[email protected]",
      "tenantId": 2,
      "status": "Pending",
      "statusUpdatedAt": "2026-02-05T00:00:47.223Z",
      "statusMessage": "Report in queue"
    }
  ]
}

Create a new report request.

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestringRequiredExample: 2023 GPU report

descriptionstringOptionalExample: This report shows the GPU usage of all projects in the organization

startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07T09:09:18.211Z

endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07T12:09:18.211Z

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: 237

{
  "name": "2023 GPU report",
  "description": "This report shows the GPU usage of all projects in the organization",
  "start": "2023-06-07T09:09:18.211Z",
  "end": "2023-06-07T12:09:18.211Z",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ]
}

{
  "name": "2023 GPU report",
  "description": "This report shows the GPU usage of all projects in the organization",
  "start": "2023-06-07T09:09:18.211Z",
  "end": "2023-06-07T12:09:18.211Z",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-02-05T00:00:47.223Z",
  "createdBy": "[email protected]",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-02-05T00:00:47.223Z",
  "statusMessage": "Report in queue"
}

Count reports

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: ["name!=some-name"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/reports/count

HTTPcURLJavaScriptPython

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

{
  "count": 1
}

Reports availability

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/reports/availability

HTTPcURLJavaScriptPython

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

{
  "isAvailable": true
}

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

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",
  "description": "This report shows the GPU usage of all projects in the organization",
  "start": "2023-06-07T09:09:18.211Z",
  "end": "2023-06-07T12:09:18.211Z",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-02-05T00:00:47.223Z",
  "createdBy": "[email protected]",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-02-05T00:00:47.223Z",
  "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: */*