Reports
Bearer authentication
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 >=.
["name!=some-name"]Sort results by a parameters.
Sort results in descending or ascending order.
ascPossible values: The offset of the first item returned in the collection.
100The maximum number of entries to return.
50Filter results by a free text search.
test projectExecuted successfully.
Bad request.
Unauthorized
Forbidden
unexpected error
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-01-01T00:00:00.000Z",
"createdBy": "user@run.ai",
"tenantId": 2,
"status": "Pending",
"statusUpdatedAt": "2026-01-01T00:00:00.000Z",
"statusMessage": "Report in queue"
}
]
}Bearer authentication
2023 GPU reportThis report shows the GPU usage of all projects in the organizationtimestamp from when to fetch data in UTC
2023-06-07T09:09:18.211Ztimestamp until when to fetch data in UTC
2023-06-07T12:09:18.211ZFilter results by a parameter. Use the format field-name == value.
[]Example: ["projectName==some-name"]Accepted.
2023 GPU reportThis report shows the GPU usage of all projects in the organizationtimestamp from when to fetch data in UTC
2023-06-07T09:09:18.211Ztimestamp until when to fetch data in UTC
2023-06-07T12:09:18.211ZFilter results by a parameter. Use the format field-name == value.
[]Example: ["projectName==some-name"]user@run.aiID of the tenant where the project is located.
2Report in queueBad request.
Unauthorized
Forbidden
unexpected error
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-01-01T00:00:00.000Z",
"createdBy": "user@run.ai",
"tenantId": 2,
"status": "Pending",
"statusUpdatedAt": "2026-01-01T00:00:00.000Z",
"statusMessage": "Report in queue"
}Bearer authentication
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 >=.
["name!=some-name"]Filter results by a free text search.
test projectExecuted successfully.
1Bad request.
Unauthorized
Forbidden
unexpected error
GET /api/v1/org-unit/reports/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1
}Bearer authentication
Executed successfully.
trueUnauthorized
unexpected error
GET /api/v1/org-unit/reports/availability HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"isAvailable": true
}Bearer authentication
The report id
575c19e8-c7c3-45b0-8290-2f47397a8383Executed successfully.
2023 GPU reportThis report shows the GPU usage of all projects in the organizationtimestamp from when to fetch data in UTC
2023-06-07T09:09:18.211Ztimestamp until when to fetch data in UTC
2023-06-07T12:09:18.211ZFilter results by a parameter. Use the format field-name == value.
[]Example: ["projectName==some-name"]user@run.aiID of the tenant where the project is located.
2Report in queueBad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
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-01-01T00:00:00.000Z",
"createdBy": "user@run.ai",
"tenantId": 2,
"status": "Pending",
"statusUpdatedAt": "2026-01-01T00:00:00.000Z",
"statusMessage": "Report in queue"
}Bearer authentication
The report id
575c19e8-c7c3-45b0-8290-2f47397a8383No Content.
No content
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
DELETE /api/v1/org-unit/reports/{reportId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Bearer authentication
The report id
575c19e8-c7c3-45b0-8290-2f47397a8383Executed successfully.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
unexpected error
GET /api/v1/org-unit/reports/{reportId}/file HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Last updated