Skip to main content
GET
/
api
/
v2
/
report-run
/
get
Get a report run
curl --request GET \
  --url https://app.octavehq.com/api/v2/report-run/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "title": "<string>",
    "summary": "<string>",
    "sections": [
      {
        "oId": "<string>",
        "topic": "<string>",
        "details": "<string>",
        "sectionOrder": 123,
        "evidenceCount": 123
      }
    ],
    "comparisonWithPrevious": {},
    "windowStart": "<string>",
    "windowEnd": "<string>"
  }
}

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

oId
string
required

Report run oId (rr_ prefix)

Example:

"rr_abc123"

Response

200 - application/json

Report run detail

_metadata
object
required
data
object
required