List Events
curl --request GET \
--url https://app.octavehq.com/api/v2/event/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/event/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/event/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/event/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/event/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/event/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/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": {
"events": [
{
"oId": "<string>",
"eventType": "EMAIL_SENT",
"eventTimestamp": "2023-11-07T05:31:56Z",
"processingStatus": "<string>",
"providerName": "<string>",
"eventSummary": "<string>",
"callPurpose": "DISCOVERY"
}
],
"total": 123,
"hasMore": true
}
}Events
List Events
GET
/
api
/
v2
/
event
/
list
List Events
curl --request GET \
--url https://app.octavehq.com/api/v2/event/list \
--header 'api_key: <api-key>'import requests
url = "https://app.octavehq.com/api/v2/event/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/event/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/event/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/event/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/event/list")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/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": {
"events": [
{
"oId": "<string>",
"eventType": "EMAIL_SENT",
"eventTimestamp": "2023-11-07T05:31:56Z",
"processingStatus": "<string>",
"providerName": "<string>",
"eventSummary": "<string>",
"callPurpose": "DISCOVERY"
}
],
"total": 123,
"hasMore": true
}
}Authorizations
Query Parameters
Start of the time range (ISO 8601 datetime)
End of the time range (ISO 8601 datetime). Defaults to now.
Maximum number of events to return (max 100)
Required range:
x <= 100Number of events to skip for pagination
Filter by event types
Available options:
EMAIL_SENT, EMAIL_REPLY_RECEIVED, CALL_TRANSCRIPT, DEAL_WON, DEAL_LOST, OPPORTUNITY_CREATED, MEETING_BOOKED, RESOURCE_INDEXED, RESOURCE_REINDEXED, PROJECT_UPDATE, TASK_COMPLETED, ENTITY_CREATED, ENTITY_UPDATED, SOCIAL_MESSAGE_SENT, SOCIAL_MESSAGE_RECEIVED, SOCIAL_CONNECTION_SENT, SOCIAL_CONNECTION_ACCEPTED, AD_SET_PUBLISHED, AD_PERFORMANCE_SNAPSHOT, BULK_IMPORT_SUMMARY, PROCESSING_NOT_APPLICABLE, PROVIDER_EVENT_TYPE_UNKNOWN, UNKNOWN Filter by event categories
Available options:
EMAIL, CALL, CRM, RESOURCE, REVISION, SOCIAL, ADS, PRODUCT, UNKNOWN Filter calls by classified purpose (single value, repeated param, or comma-separated)
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 Response
200 - application/json
List of events for the workspace
Show child attributes
Show child attributes