curl --request GET \
--url https://app.octavehq.com/api/v2/insights/entity-usage \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/insights/entity-usage"
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/entity-usage', 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/entity-usage",
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/entity-usage"
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/entity-usage")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/insights/entity-usage")
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": {
"entityOId": "<string>",
"entityType": "offering",
"usage": {
"totalFindings": 123,
"totalEvents": 123,
"findingsByChannel": [
{
"channel": "<string>",
"count": 123,
"eventCount": 123
}
],
"firstMentioned": "<string>",
"lastMentioned": "<string>",
"daysSinceLastMentioned": 123,
"trend": {
"recentFindings": 123,
"priorFindings": 123,
"halfWindowDays": 123,
"direction": "rising"
},
"windowDays": 123,
"dailyCounts": [
123
],
"dailyCountsStartDate": "<string>",
"dealOutcomes": {
"dealsWon": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"dealsLost": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"dealsOpen": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"presenceRate": 123,
"winRate": 123,
"winRateWithoutEntity": 123,
"liftScore": 123,
"wonAmount": 123,
"sentiment": {
"positive": 123,
"neutral": 123,
"negative": 123,
"unknown": 123
}
}
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Entity Usage
A library entity’s activity record: mention and conversation counts, the per-channel split, first/last mention, days since last mention, a daily series, whether mentions are rising or falling, and the window’s deal outcomes (presence, win rate, lift) when the workspace has analytics. Use insights/entity-stats instead for per-period buckets. Accepts any library entity oId — the type is derived from its prefix. Entity types with no conversation surface (brand voices, skills) return 400 rather than an empty report.
curl --request GET \
--url https://app.octavehq.com/api/v2/insights/entity-usage \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/insights/entity-usage"
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/entity-usage', 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/entity-usage",
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/entity-usage"
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/entity-usage")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/insights/entity-usage")
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": {
"entityOId": "<string>",
"entityType": "offering",
"usage": {
"totalFindings": 123,
"totalEvents": 123,
"findingsByChannel": [
{
"channel": "<string>",
"count": 123,
"eventCount": 123
}
],
"firstMentioned": "<string>",
"lastMentioned": "<string>",
"daysSinceLastMentioned": 123,
"trend": {
"recentFindings": 123,
"priorFindings": 123,
"halfWindowDays": 123,
"direction": "rising"
},
"windowDays": 123,
"dailyCounts": [
123
],
"dailyCountsStartDate": "<string>",
"dealOutcomes": {
"dealsWon": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"dealsLost": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"dealsOpen": {
"withEntity": 123,
"workspaceTotal": 123,
"share": 123
},
"presenceRate": 123,
"winRate": 123,
"winRateWithoutEntity": 123,
"liftScore": 123,
"wonAmount": 123,
"sentiment": {
"positive": 123,
"neutral": 123,
"negative": 123,
"unknown": 123
}
}
}
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Query Parameters
The oId of any library entity. The type is derived from the oId prefix (pe_ persona, px_ product, sg_ segment, uu_ use case, cp_ competitor, …).
Lookback window in days. Scopes the mention/conversation counts, the channel split, the daily series and the trend comparison. First/last mention stay all-time.
1 <= x <= 365Inclusive YYYY-MM-DD start of an explicit window scoping the aggregate counts, overriding days for those counts only. Must be sent together with end. First/last mention stay all-time and the daily series stays the full days window — so with a range narrower than days, the counts and the trend cover different spans.
^\d{4}-\d{2}-\d{2}$Inclusive YYYY-MM-DD end of the aggregate window.
^\d{4}-\d{2}-\d{2}$Response
Finding-activity usage for a single library entity
Show child attributes
Show child attributes