Skip to main content
GET
/
api
/
v2
/
insights
/
top-entities
Top Entities
curl --request GET \
  --url https://app.octavehq.com/api/v2/insights/top-entities \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "oId": "<string>",
      "entityOId": "<string>",
      "periodStart": "<string>",
      "periodEnd": "<string>",
      "wonDealCount": 123,
      "lostDealCount": 123,
      "noDecisionDealCount": 123,
      "openDealCount": 123,
      "wonDealTotalAmount": "<string>",
      "lostDealTotalAmount": "<string>",
      "totalFindingCount": 123,
      "uniqueEventCount": 123,
      "uniqueCompanyCount": 123,
      "uniqueContactCount": 123,
      "winRate": 123,
      "relativeWinRate": 123,
      "liftScore": 123,
      "winRateDelta": 123,
      "isUbiquitous": true,
      "dealsWherePresent": 123,
      "dealsWhereAbsent": 123,
      "lastComputedAt": "<string>",
      "entityName": "<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

periodType
enum<string>
required

Period granularity

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

Start of the period window (ISO datetime)

limit
integer
default:10

Max number of results to return

Required range: 1 <= x <= 50
sort
enum<string>
default:desc

desc = highest lift first (what's working); asc = lowest lift first

Available options:
asc,
desc
entityTypes
enum<string>[]

Filter to specific entity types. Omit for all types.

Available options:
persona,
product,
service,
solution,
use_case,
playbook,
proof_point,
competitor,
alternative,
buying_trigger,
objection,
reference,
hypothesis,
segment,
target_icp,
motion_icp

Response

200 - application/json

Top (or bottom) entities ranked by lift score

data
object[]
required