curl --request GET \
--url https://app.octavehq.com/api/v2/intel/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/intel/list"
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/intel/list', 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/intel/list",
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/intel/list"
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/intel/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/intel/list")
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{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"intel": [
{
"oId": "<string>",
"name": "<string>",
"type": "MICRO",
"confidence": "SPECULATIVE",
"strategicImpact": "CRITICAL",
"mode": "AUTO",
"source": "RESEARCH",
"createdAt": "<string>",
"updatedAt": "<string>",
"lifecycleStatus": "ACTIVE",
"targetEntityType": "segment",
"targetEntityOId": "<string>",
"description": "<string>",
"permanence": "PASSING",
"citationCount": 0,
"expectedDuration": "<string>",
"targetName": "<string>",
"detail": {
"oId": "<string>",
"targetEntityType": "segment",
"targetEntityOId": "<string>",
"name": "<string>",
"type": "MICRO",
"confidence": "SPECULATIVE",
"strategicImpact": "CRITICAL",
"lifecycleStatus": "ACTIVE",
"mode": "AUTO",
"source": "RESEARCH",
"data": {
"expectedDuration": "<string>",
"howThisImpactsThem": [],
"howThisInfluencesOurApproach": [],
"citations": []
},
"createdAt": "<string>",
"updatedAt": "<string>",
"targetName": "<string>",
"description": "<string>",
"permanence": "PASSING",
"archivedReason": "<string>",
"invalidationReason": "<string>",
"invalidatedBy": "USER",
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"expiresAt": "<string>",
"lastValidatedAt": "<string>",
"archivedAt": "<string>"
}
}
],
"total": 123,
"hasNext": true,
"limit": 123,
"offset": 123,
"intelEnabled": true,
"hydrated": true
}List intel
Read researched competitor, segment and market intel. Respects workspace and target intel settings. List defaults to active, non-archived records; use lifecycleStatuses for retired intel. Timestamps reflect record changes, including revalidation, rather than source publication dates.
curl --request GET \
--url https://app.octavehq.com/api/v2/intel/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/intel/list"
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/intel/list', 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/intel/list",
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/intel/list"
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/intel/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/intel/list")
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{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"intel": [
{
"oId": "<string>",
"name": "<string>",
"type": "MICRO",
"confidence": "SPECULATIVE",
"strategicImpact": "CRITICAL",
"mode": "AUTO",
"source": "RESEARCH",
"createdAt": "<string>",
"updatedAt": "<string>",
"lifecycleStatus": "ACTIVE",
"targetEntityType": "segment",
"targetEntityOId": "<string>",
"description": "<string>",
"permanence": "PASSING",
"citationCount": 0,
"expectedDuration": "<string>",
"targetName": "<string>",
"detail": {
"oId": "<string>",
"targetEntityType": "segment",
"targetEntityOId": "<string>",
"name": "<string>",
"type": "MICRO",
"confidence": "SPECULATIVE",
"strategicImpact": "CRITICAL",
"lifecycleStatus": "ACTIVE",
"mode": "AUTO",
"source": "RESEARCH",
"data": {
"expectedDuration": "<string>",
"howThisImpactsThem": [],
"howThisInfluencesOurApproach": [],
"citations": []
},
"createdAt": "<string>",
"updatedAt": "<string>",
"targetName": "<string>",
"description": "<string>",
"permanence": "PASSING",
"archivedReason": "<string>",
"invalidationReason": "<string>",
"invalidatedBy": "USER",
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"expiresAt": "<string>",
"lastValidatedAt": "<string>",
"archivedAt": "<string>"
}
}
],
"total": 123,
"hasNext": true,
"limit": 123,
"offset": 123,
"intelEnabled": true,
"hydrated": true
}Authorizations
Query Parameters
1 <= x <= 100x >= 0Field used to order matching intel (default: createdAt).
createdAt, updatedAt, name Sort direction (default: desc).
asc, desc Only return intel for this target type: segment, competitor, or workspace_company.
segment, competitor, workspace_company 1Return records updated after this ISO timestamp. Revalidation also updates timestamps; this is a sync filter, not an activity count.
ACTIVE, INVALIDATED, EXPIRED true, false Response
Intel
Show child attributes
Show child attributes
The requested page of intel.
Show child attributes
Show child attributes
Total intel items matching the filters.
Whether there are more matching intel items after this page.
Maximum results per page.
Current pagination offset.
False when Intel is turned off for every target type in Library Settings.
Whether detail is populated on each item.