Skip to main content
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>'
import requests

url = "https://app.octavehq.com/api/v2/report-config/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/report-config/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/report-config/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/report-config/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/report-config/list")
.header("api_key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/report-config/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"
  },
  "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
}

Authorizations

api_key
string
header
required

Query Parameters

groupOId
string

Filter by report group oId

Response

200 - application/json

Report config list

_metadata
object
required
data
object[]
required
total
number
required

Total configs returned