List Findings
curl --request GET \
--url https://app.octavehq.com/api/v2/finding/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/finding/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/finding/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/finding/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/finding/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/finding/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/finding/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{
"data": {
"findings": [
{
"oId": "<string>",
"extractionType": "EMAIL_INTERNAL_USE_CASE",
"snippetText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"callPurpose": "DISCOVERY",
"customExtractor": {
"oId": "<string>",
"name": "<string>",
"promptVersion": 1,
"modelTier": "NOTE",
"model": "<string>"
},
"structuredValue": {}
}
],
"total": 123,
"hasMore": true
}
}Findings
List Findings
GET
/
api
/
v2
/
finding
/
list
List Findings
curl --request GET \
--url https://app.octavehq.com/api/v2/finding/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/finding/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/finding/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/finding/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/finding/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/finding/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/finding/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{
"data": {
"findings": [
{
"oId": "<string>",
"extractionType": "EMAIL_INTERNAL_USE_CASE",
"snippetText": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"callPurpose": "DISCOVERY",
"customExtractor": {
"oId": "<string>",
"name": "<string>",
"promptVersion": 1,
"modelTier": "NOTE",
"model": "<string>"
},
"structuredValue": {}
}
],
"total": 123,
"hasMore": true
}
}Authorizations
Query Parameters
Start of the time range (ISO 8601 datetime)
End of the time range (ISO 8601 datetime)
Maximum number of findings to return (max 100)
Required range:
x <= 100Number of findings to skip for pagination
Filter by extraction type
Available options:
EMAIL_INTERNAL_USE_CASE, EMAIL_INTERNAL_PROOF_POINT, EMAIL_INTERNAL_PAIN_POINT, EMAIL_INTERNAL_BENEFITS_HIGHLIGHTED, EMAIL_INTERNAL_VALUE_PROP, EMAIL_INTERNAL_SOCIAL_PROOF, EMAIL_INTERNAL_CALL_TO_ACTION, EMAIL_INTERNAL_OBJECTION_HANDLING, EMAIL_INTERNAL_COMPETITORS_TO_OUR_OFFERING, EMAIL_INTERNAL_CORE_CAPABILITIES, EMAIL_INTERNAL_DIFFERENTIATED_VALUE, EMAIL_INTERNAL_COMPLEMENTARY_TOOLS_MENTIONED, EMAIL_INTERNAL_BUYING_TRIGGER_CITED, EMAIL_INTERNAL_COMMITMENTS_MADE, EMAIL_EXTERNAL_CALL_TO_ACTION, EMAIL_EXTERNAL_OBJECTION, EMAIL_EXTERNAL_QUESTION, EMAIL_EXTERNAL_INTEREST_EXPRESSION, EMAIL_EXTERNAL_FEATURE_REQUEST, EMAIL_EXTERNAL_REQUIREMENT, EMAIL_EXTERNAL_PRICING_FEEDBACK, EMAIL_EXTERNAL_COMPARATIVE_STATEMENT, EMAIL_EXTERNAL_KEY_TAKEAWAY, EMAIL_EXTERNAL_COMPETITOR_MENTION, EMAIL_EXTERNAL_NEXT_STEP, EMAIL_EXTERNAL_URGENCY_INDICATOR, EMAIL_EXTERNAL_DECISION_MAKING_SIGNAL, EMAIL_EXTERNAL_UNIQUE_LANGUAGE_USED, EMAIL_EXTERNAL_BUSINESS_PROBLEMS, EMAIL_EXTERNAL_PRIMARY_GOALS, EMAIL_EXTERNAL_STATUS_QUO_HOW_THEY_SOLVE_TODAY, EMAIL_EXTERNAL_CURRENT_TOOL_OR_SOLUTION_PROBLEMS, EMAIL_EXTERNAL_PAIN_OR_PROBLEM_AGREEMENTS, EMAIL_EXTERNAL_ROLE_OR_RESPONSIBILITIES_DESCRIPTION, EMAIL_EXTERNAL_CORE_CAPABILITIES, EMAIL_EXTERNAL_USE_CASES_BROUGHT_UP, EMAIL_EXTERNAL_BLOCKERS_OR_DEPENDENCIES, EMAIL_EXTERNAL_ABSENT_STAKEHOLDER_MENTIONS, EMAIL_EXTERNAL_FRUSTRATION_OR_DISAPPOINTMENT, EMAIL_OVERALL_SENTIMENT, EMAIL_TITLE_TO_PERSONA, EMAIL_SEGMENT_DESCRIPTION, SOCIAL_INTERNAL_USE_CASE, SOCIAL_INTERNAL_PROOF_POINT, SOCIAL_INTERNAL_PAIN_POINT, SOCIAL_INTERNAL_VALUE_PROP, SOCIAL_INTERNAL_SOCIAL_PROOF, SOCIAL_INTERNAL_CALL_TO_ACTION, SOCIAL_INTERNAL_BENEFITS_HIGHLIGHTED, SOCIAL_INTERNAL_OBJECTION_HANDLING, SOCIAL_TITLE_TO_PERSONA, SOCIAL_SEGMENT_DESCRIPTION, SOCIAL_EXTERNAL_CALL_TO_ACTION, SOCIAL_EXTERNAL_OBJECTION, SOCIAL_EXTERNAL_QUESTION, SOCIAL_EXTERNAL_INTEREST_EXPRESSION, SOCIAL_EXTERNAL_FEATURE_REQUEST, SOCIAL_EXTERNAL_REQUIREMENT, SOCIAL_EXTERNAL_PRICING_FEEDBACK, SOCIAL_EXTERNAL_COMPARATIVE_STATEMENT, SOCIAL_EXTERNAL_KEY_TAKEAWAY, SOCIAL_EXTERNAL_COMPETITOR_MENTION, SOCIAL_EXTERNAL_NEXT_STEP, SOCIAL_EXTERNAL_URGENCY_INDICATOR, SOCIAL_EXTERNAL_DECISION_MAKING_SIGNAL, SOCIAL_EXTERNAL_UNIQUE_LANGUAGE_USED, SOCIAL_OVERALL_SENTIMENT, CALL_EXTERNAL_BUSINESS_PROBLEMS, CALL_EXTERNAL_IDEAL_SOLUTION_DESCRIPTION, CALL_EXTERNAL_PRIMARY_GOALS, CALL_EXTERNAL_WHY_ON_THIS_CALL, CALL_EXTERNAL_STATUS_QUO_HOW_THEY_SOLVE_TODAY, CALL_EXTERNAL_INDUSTRY_TRENDS, CALL_EXTERNAL_COMPETITORS_TO_OUR_OFFERING, CALL_EXTERNAL_COMPETITORS_OF_THEIR_COMPANY, CALL_EXTERNAL_CURRENT_TOOL_OR_SOLUTION_PROBLEMS, CALL_EXTERNAL_OBJECTIONS, CALL_EXTERNAL_PAIN_OR_PROBLEM_AGREEMENTS, CALL_EXTERNAL_ROLE_OR_RESPONSIBILITIES_DESCRIPTION, CALL_EXTERNAL_QUESTIONS_OR_CONFUSION_ABOUT_OFFERING, CALL_EXTERNAL_CAPABILITIES_THAT_DREW_EXCITEMENT, CALL_EXTERNAL_UNIQUE_LANGUAGE_USED, CALL_EXTERNAL_FEATURE_REQUEST, CALL_EXTERNAL_COMMITMENTS_MADE, CALL_EXTERNAL_PRICING_OR_PACKAGING_FEEDBACK, CALL_EXTERNAL_BLOCKERS_OR_DEPENDENCIES, CALL_EXTERNAL_ABSENT_STAKEHOLDER_MENTIONS, CALL_EXTERNAL_FRUSTRATION_OR_DISAPPOINTMENT, CALL_EXTERNAL_CORE_CAPABILITIES, CALL_EXTERNAL_USE_CASES_BROUGHT_UP, CALL_INTERNAL_USE_CASES_BROUGHT_UP, CALL_INTERNAL_PROOF_POINTS, CALL_INTERNAL_REFERENCE_CUSTOMERS_OR_SOCIAL_PROOF, CALL_INTERNAL_COMPETITORS, CALL_INTERNAL_COMPETITORS_TO_OUR_OFFERING, CALL_INTERNAL_OBJECTION_HANDLING, CALL_INTERNAL_VALUE_PROP_PRESENTATIONS, CALL_INTERNAL_DIFFERENTIATED_VALUE, CALL_INTERNAL_CORE_CAPABILITIES, CALL_INTERNAL_COMPLEMENTARY_TOOLS_MENTIONED, CALL_INTERNAL_COMMITMENTS_MADE, CALL_COMPETITOR_MENTION_ORIGIN, CALL_COMPETITOR_RELATIONSHIP_STATUS, CALL_COMPETITOR_MENTAL_MODEL, CALL_COMPETITOR_PROSPECT_VOICED_STRENGTH, CALL_COMPETITOR_PROSPECT_VOICED_WEAKNESS, CALL_COMPETITOR_OVERALL_STANCE, CALL_COMPETITOR_HEAD_TO_HEAD_COMPARISON, CALL_COMPETITOR_CONSIDERATION_SET_ALTERNATIVE, CALL_COMPETITOR_COMMERCIAL_INTEL, CALL_COMPETITOR_SWITCHING_TRIGGER_OR_BARRIER, CALL_COMPETITOR_REP_CLAIM_REACTION, CALL_COMPETITOR_DEAL_IMPACT, CALL_CORE_FEATURE_MENTION_ORIGIN, CALL_CORE_FEATURE_PROSPECT_LANGUAGE, CALL_CORE_FEATURE_COMPREHENSION_CORRECTION, CALL_CORE_FEATURE_PROSPECT_REACTION, CALL_CORE_FEATURE_PROSPECT_QUESTION, CALL_CORE_FEATURE_PROBLEM_ATTACHMENT, CALL_CORE_FEATURE_VALUE_ARTICULATION, CALL_CORE_FEATURE_CONCERN_OR_REQUIREMENT, CALL_CORE_FEATURE_STATUS_QUO, CALL_CORE_FEATURE_COMPARISON, CALL_CORE_FEATURE_DECISION_WEIGHT, CALL_CORE_FEATURE_USAGE_STAKEHOLDER, CALL_OBJECTION_UNDERLYING_CONCERN, CALL_OBJECTION_ASSUMPTION_OR_MISCONCEPTION, CALL_OBJECTION_SEVERITY, CALL_OBJECTION_STANCE, CALL_OBJECTION_UNPROBED_GAP, CALL_OBJECTION_REP_RESPONSE, CALL_OBJECTION_PROOF_DEMANDED, CALL_OBJECTION_RESOLUTION_STATE, CALL_ALTERNATIVE_APPROACH_STANCE, CALL_ALTERNATIVE_INCUMBENCY_STATE, CALL_ALTERNATIVE_BUILD_AND_MAINTENANCE, CALL_ALTERNATIVE_RATIONAL_CASE, CALL_ALTERNATIVE_PERCEIVED_BENEFIT, CALL_ALTERNATIVE_VOICED_LIMITATION, CALL_ALTERNATIVE_SWITCHING_BARRIER, CALL_ALTERNATIVE_DISPLACEMENT_TRIGGER, CALL_ALTERNATIVE_DEFENDER, CALL_ALTERNATIVE_REP_POSITIONING, CALL_ALTERNATIVE_STANDING, RESOURCE_USE_CASES, RESOURCE_PROOF_POINTS, RESOURCE_REFERENCE_CUSTOMERS, RESOURCE_COMPETITORS, RESOURCE_OBJECTION_HANDLING, RESOURCE_VALUE_PROPS, RESOURCE_DIFFERENTIATED_VALUE, RESOURCE_CORE_CAPABILITIES, RESOURCE_SEGMENTS, RESOURCE_INTEGRATIONS_PARTNERS, RESOURCE_UNIQUE_LANGUAGE, RESOURCE_PAIN_POINTS, RESOURCE_TARGET_PERSONAS, RESOURCE_ALTERNATIVES, RESOURCE_BUYING_TRIGGERS, DECLARED_ENTITY_USE_CASES, DECLARED_ENTITY_COMPETITORS, DECLARED_ENTITY_PROOF_POINTS, CALL_OVERALL_SENTIMENT, CALL_PURPOSE_CLASSIFICATION, CALL_TITLE_TO_PERSONA, CALL_SEGMENT_DESCRIPTION, CRM_TITLE_TO_PERSONA, CRM_SEGMENT_DESCRIPTION, EVENT_SUMMARY, BULK_IMPORT_THEMES, BULK_LOSS_REASONS, BULK_WIN_REASONS, BULK_PAIN_POINTS, BULK_USE_CASES, BULK_COMPETITORS, BULK_OBJECTIONS, BULK_SEGMENTS, BULK_PERSONAS, ADS_INTERNAL_MESSAGING_THEME, ADS_INTERNAL_TARGET_AUDIENCE, ADS_INTERNAL_COMPETITIVE_POSITIONING, ADS_INTERNAL_KEYWORD_TARGETING, ADS_EXTERNAL_ENGAGEMENT_SIGNAL, ADS_SEGMENT_DESCRIPTION, ADS_MOTION_TYPE, ADS_OFFERING_MATCH, CALL_PROSPECT_RELATIONSHIP_TO_SELLER, CALL_MOTION_TYPE, CALL_OFFERING_MATCH, EMAIL_PROSPECT_RELATIONSHIP_TO_SELLER, EMAIL_REPLY_PURPOSE_CLASSIFICATION, EMAIL_MOTION_TYPE, EMAIL_OFFERING_MATCH, CRM_MOTION_TYPE, CRM_OFFERING_MATCH, RESOURCE_OFFERING_MATCH, RESOURCE_TYPE_CLASSIFICATION, CUSTOM Filter to findings from calls classified with any of these purposes (single value, repeated param, or comma-separated). Only call events carry a purpose, so this also narrows results to calls.
Available options:
DISCOVERY, DEMO, TECHNICAL_EVALUATION, WORKING_SESSION, NEGOTIATION_PRICING, ONBOARDING, CHECK_IN_SUCCESS, QBR_RENEWAL, EXPANSION_UPSELL, ESCALATION_CHURN_RISK, SUPPORT, INTERNAL_SYNC, OTHER Filter to findings produced by any of these workspace-defined custom extractors, by oId (single value, repeated param, or comma-separated). Only CUSTOM findings carry a producing extractor, so this also narrows results to that extraction type.
Response
200 - application/json
List of extracted findings for the workspace
Show child attributes
Show child attributes