Dimensional usage analytics (users per region, revenue per product). Reserved: currently returns an empty report.

GET

/api/v1/provision/admin/reports/usage-analytics

curl --request GET \
  --url https://example.com/api/v1/provision/admin/reports/usage-analytics

Responses

200

OK

Reserved contract for dimensional analytics (e.g. users per region, revenue per product).

object

generatedAtUtc

string format: date-time

dimensions

Array<object>

A single dimensional breakdown within an analytics report.

object

dimensionName

Dimension name, e.g. “users.by-region”, “revenue.by-product”.

string

displayName

string

buckets

Array<object>

A single bucket/slice within a dimension.

object

label

Bucket label, e.g. “Europe”, “North America”.

string

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

Reserved contract for dimensional analytics (e.g. users per region, revenue per product).

object

generatedAtUtc

string format: date-time

dimensions

Array<object>

A single dimensional breakdown within an analytics report.

object

dimensionName

Dimension name, e.g. “users.by-region”, “revenue.by-product”.

string

displayName

string

buckets

Array<object>

A single bucket/slice within a dimension.

object

label

Bucket label, e.g. “Europe”, “North America”.

string

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

Example ^generated

{
  "generatedAtUtc": "2026-04-15T12:00:00Z",
  "dimensions": [
    {
      "dimensionName": "example",
      "displayName": "example",
      "buckets": [
        {
          "label": "example",
          "value": 1
        }
      ]
    }
  ]
}

Reserved contract for dimensional analytics (e.g. users per region, revenue per product).

object

generatedAtUtc

string format: date-time

dimensions

Array<object>

A single dimensional breakdown within an analytics report.

object

dimensionName

Dimension name, e.g. “users.by-region”, “revenue.by-product”.

string

displayName

string

buckets

Array<object>

A single bucket/slice within a dimension.

object

label

Bucket label, e.g. “Europe”, “North America”.

string

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

Example ^generated

{
  "generatedAtUtc": "2026-04-15T12:00:00Z",
  "dimensions": [
    {
      "dimensionName": "example",
      "displayName": "example",
      "buckets": [
        {
          "label": "example",
          "value": 1
        }
      ]
    }
  ]
}

401

Unauthorized

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}