Skip to main content
GET
/
api
/
v2
/
finding
/
list
List Findings
curl --request GET \
  --url https://app.octavehq.com/api/v2/finding/list \
  --header 'api_key: <api-key>'
{
  "data": {
    "findings": [
      {
        "oId": "<string>",
        "snippetText": "<string>",
        "createdAt": "<string>"
      }
    ],
    "total": 123,
    "hasMore": true
  }
}

Authorizations

​
api_key
string
header
required

Query Parameters

​
startDate
string<date-time>

Start of the time range (ISO 8601 datetime)

​
endDate
string<date-time>

End of the time range (ISO 8601 datetime)

​
limit
integer | null
default:20

Maximum number of findings to return (max 100)

Required range: x <= 100
​
offset
integer | null
default:0

Number of findings to skip for pagination

​
extractionType
enum<string>

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_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_OVERALL_SENTIMENT,
EMAIL_INTERNAL_TITLE_TO_PERSONA,
EMAIL_EXTERNAL_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_INTERNAL_TITLE_TO_PERSONA,
SOCIAL_SEGMENT_DESCRIPTION,
SOCIAL_PLAYBOOK_TOPICS,
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_EXTERNAL_TITLE_TO_PERSONA,
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_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,
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,
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_MOTION_TYPE,
EMAIL_OFFERING_MATCH,
CRM_MOTION_TYPE,
CRM_OFFERING_MATCH,
CALL_PLAYBOOK_TOPICS,
EMAIL_PLAYBOOK_TOPICS,
RESOURCE_PLAYBOOK_TOPICS,
EMAIL_PLAYBOOK_SOURCE,
SOCIAL_PLAYBOOK_SOURCE

Response

200 - application/json

List of extracted findings for the workspace

​
data
object
required