Skip to main content
GET
/
api
/
v2
/
report-group
/
list
List report groups
curl --request GET \
  --url https://app.octavehq.com/api/v2/report-group/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "title": "<string>",
      "isActive": true,
      "aggregationLevel": "<string>",
      "configCount": 123,
      "lastRun": "<string>",
      "description": "<string>",
      "createdBy": "<string>",
      "nextRunAt": "<string>",
      "timezone": "<string>"
    }
  ],
  "total": 123,
  "hasNext": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Query Parameters

limit
number
default:50

Limit

Required range: x > 0
Example:

50

offset
number | null
default:0

Offset

Required range: x >= 0
Example:

0

Response

200 - application/json

Report group list

_metadata
object
required
data
object[]
required
total
number
required

Total matching groups

hasNext
boolean
required

Whether more results exist