Skip to main content
API docs by Redocly

Reports API (1.0.0)

The Reports API currently provides access to the Resource Usage Summary report. This report offers detailed insights into your organization's usage of service level objectives (SLOs), SLO units, composite SLO components, data sources, and users, helping you track resource consumption and manage your service performance.

Scroll down to see code samples

Access Token

Generate access token

To generate access token, you must provide Authorization header with the Basic scheme.

The access token consists of your Client ID and Client Secret in the following format: clientId:clientSecret.

Rate Limits for access token

All requests to the endpoint /api/accessToken are rate limited. An organization can make 1 request per 3 seconds.

The API returns the 429 HTTP status code when this limit is exceeded.

NOTE
Your token will be valid for 1 hour. Minimize the usage of this endpoint and reuse the token until it expires.

We recommend downloading your token once and reusing it in your CI/CD pipeline. Generating multiple tokens may exceed your rate limits.

Authorizations:
basicAuth
header Parameters
organization
required
string

Your organization ID

Responses

Request samples 

curl -X \
POST https://app.nobl9.com/api/accessToken -H 'Accept: application/json; version=v1alpha' \
-H 'Organization: your-organization-id' \
-H 'Authorization: Basic ${encoded_access_keys}'

Response samples

Content type
application/json
{
  • "access_token": "string"
}

Get resource usage summary report

Retrieve a summary of resource usage. For detailed information, check the Resource Usage Summary report.

Authorizations:
bearerAuth
header Parameters
organization
required
string

Your organization ID

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "usageSummary": {
    }
}