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>'
import requests

url = "https://app.octavehq.com/api/v2/insights/library-health"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/insights/library-health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/insights/library-health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.octavehq.com/api/v2/insights/library-health"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("api_key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/insights/library-health")
.header("api_key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/insights/library-health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "entityType": "<string>",
      "entityCount": 123,
      "totalFindings": 123,
      "callFindings": 123,
      "emailFindings": 123,
      "wonDealCount": 123,
      "lostDealCount": 123,
      "totalDeals": 123
    }
  ]
}

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