Get Dashboard

GET /api/v1/orgs/current/dashboard

Error

A valid request URL is required to generate request examples

200

{
  "embeddable_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Query Parameters

type · enum<string> · required

Enum for acceptable types of dashboards.

Available options: invoices, usage, credits

color_scheme · enum<string> | null · required

Enum for acceptable color schemes of dashboards.

Available options: light, dark

Response

200

application/json

Successful Response

Organization dashboard for usage or invoices.

embeddable_url · string · required