Reports

List reports

get
Authorizations
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
chevron-right
200

Executed successfully.

application/json
get
/api/v1/org-unit/reports

Create a new report request.

post
Authorizations
AuthorizationstringRequired

Bearer authentication

Body
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
post
/api/v1/org-unit/reports

Count reports

get
Authorizations
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
chevron-right
200

Executed successfully.

application/json
get
/api/v1/org-unit/reports/count

Reports availability

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

Executed successfully.

application/json
get
/api/v1/org-unit/reports/availability

Get report

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
chevron-right
200

Executed successfully.

application/json
get
/api/v1/org-unit/reports/{reportId}

Delete report

delete
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
delete
/api/v1/org-unit/reports/{reportId}

No content

Download report

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
chevron-right
200

Executed successfully.

text/csv
get
/api/v1/org-unit/reports/{reportId}/file

Last updated