Skip to main content
GET
/
api
/
v2
/
insights
/
library-health
Library Health
curl --request GET \
  --url https://app.octavehq.com/api/v2/insights/library-health \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "entityType": "<string>",
      "entityCount": 123,
      "totalFindings": 123,
      "callFindings": 123,
      "emailFindings": 123,
      "wonDealCount": 123,
      "lostDealCount": 123,
      "totalDeals": 123
    }
  ]
}

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

periodType
enum<string>
required

Period granularity

Available options:
week,
month,
quarter
periodStart
string<date-time>
required

Start of the period window (ISO datetime)

Response

200 - application/json

Per-entity-type health summary (findings, deal counts) for the heatmap

data
object[]
required