List report configs
curl --request GET \
--url https://app.octavehq.com/api/v2/report-config/list \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "<string>",
"title": "<string>",
"filters": {
"findings": [
{
"value": "<string>"
}
],
"events": {
"match": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"playbooks": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"playbooks": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": []
}
},
"pipelineFilters": {
"phases": [],
"stageCategories": [],
"minStalledDays": 123
},
"actions": [
{
"targetEntityTypes": []
}
],
"metadataFields": [
{
"key": "<string>",
"required": false
}
]
},
"isActive": true,
"description": "<string>",
"executionType": "adhoc",
"reportId": "<string>",
"prompt": "<string>",
"systemPrompt": "<string>",
"logicVersion": 1,
"groupId": "<string>",
"minEvents": 123,
"minFindings": 123,
"lastSuccessfulEndAt": "<string>",
"consecutiveFailures": 123,
"notificationSettings": {
"email": {
"enabled": true,
"addresses": [
"jsmith@example.com"
]
},
"slack": {
"enabled": true,
"channels": [
{
"id": "<string>",
"name": "<string>"
}
]
}
}
}
],
"total": 123
}Reports
List report configs
List report configurations, optionally filtered by group
GET
/
api
/
v2
/
report-config
/
list
List report configs
curl --request GET \
--url https://app.octavehq.com/api/v2/report-config/list \
--header 'api_key: <api-key>'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "<string>",
"title": "<string>",
"filters": {
"findings": [
{
"value": "<string>"
}
],
"events": {
"match": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"playbooks": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"playbooks": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": []
}
},
"pipelineFilters": {
"phases": [],
"stageCategories": [],
"minStalledDays": 123
},
"actions": [
{
"targetEntityTypes": []
}
],
"metadataFields": [
{
"key": "<string>",
"required": false
}
]
},
"isActive": true,
"description": "<string>",
"executionType": "adhoc",
"reportId": "<string>",
"prompt": "<string>",
"systemPrompt": "<string>",
"logicVersion": 1,
"groupId": "<string>",
"minEvents": 123,
"minFindings": 123,
"lastSuccessfulEndAt": "<string>",
"consecutiveFailures": 123,
"notificationSettings": {
"email": {
"enabled": true,
"addresses": [
"jsmith@example.com"
]
},
"slack": {
"enabled": true,
"channels": [
{
"id": "<string>",
"name": "<string>"
}
]
}
}
}
],
"total": 123
}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.
⌘I