OPopenmeter
Cloud Internal

List reports

List reports on the UI.

get/api/internal/reports

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

Query parameters

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

type'objectStorage' | 'stripe' | 'webhook'

The type of the report.

Search for reports by type.

sort'slug:asc' | 'slug:desc'

Sort reports by slug.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

{
  "items": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "schedule": {
        "startAt": "2023-01-01T01:01:01.001Z"
      }
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalCount": 500
}

Changes

No recorded changes to this operation across all 2 revisions of this API.