Event Cross-Tab
curl --request POST \
--url https://app.octavehq.com/api/v2/event/cross-tab \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"rows": {
"tagGroupOId": "<string>"
},
"columns": {
"tagGroupOId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"filters": {
"entityMatchAll": true,
"eventOIds": [
"<string>"
],
"opportunityIds": [
"<string>"
],
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"dealMotions": [],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"dealStagesAtEvent": [
"<string>"
],
"pipelinePhases": [],
"crmPipelines": [
"<string>"
],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"callPurposes": [],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"callPurposes": [],
"dealMotions": [],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"pipelinePhases": []
},
"excludeTags": [
"<string>"
],
"metric": "events",
"rowLimit": 15,
"columnLimit": 10
}
'import requests
url = "https://app.octavehq.com/api/v2/event/cross-tab"
payload = {
"rows": { "tagGroupOId": "<string>" },
"columns": { "tagGroupOId": "<string>" },
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"filters": {
"entityMatchAll": True,
"eventOIds": ["<string>"],
"opportunityIds": ["<string>"],
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": ["<string>"],
"companyDomains": ["<string>"],
"outcomeFilters": [],
"opportunityStatuses": [],
"dealMotions": [],
"dealTypes": ["<string>"],
"dealStages": ["<string>"],
"dealStagesAtEvent": ["<string>"],
"pipelinePhases": [],
"crmPipelines": ["<string>"],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": ["<string>"],
"personas": ["<string>"],
"segments": ["<string>"],
"tags": ["<string>"],
"useCases": ["<string>"],
"references": ["<string>"],
"competitors": ["<string>"],
"alternatives": ["<string>"],
"buyingTriggers": ["<string>"],
"coreFeatures": ["<string>"],
"objections": ["<string>"],
"proofPoints": ["<string>"],
"motionTypes": [],
"callPurposes": [],
"unmatchedOnly": True
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": ["<string>"],
"companyDomains": ["<string>"],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": ["<string>"],
"personas": ["<string>"],
"segments": ["<string>"],
"tags": ["<string>"],
"useCases": ["<string>"],
"references": ["<string>"],
"competitors": ["<string>"],
"alternatives": ["<string>"],
"buyingTriggers": ["<string>"],
"coreFeatures": ["<string>"],
"objections": ["<string>"],
"proofPoints": ["<string>"],
"motionTypes": [],
"callPurposes": [],
"dealMotions": [],
"dealTypes": ["<string>"],
"dealStages": ["<string>"],
"pipelinePhases": []
},
"excludeTags": ["<string>"],
"metric": "events",
"rowLimit": 15,
"columnLimit": 10
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: {tagGroupOId: '<string>'},
columns: {tagGroupOId: '<string>'},
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
filters: {
entityMatchAll: true,
eventOIds: ['<string>'],
opportunityIds: ['<string>'],
eventCategories: [],
eventTypes: [],
sentiments: [],
contactEmails: ['<string>'],
companyDomains: ['<string>'],
outcomeFilters: [],
opportunityStatuses: [],
dealMotions: [],
dealTypes: ['<string>'],
dealStages: ['<string>'],
dealStagesAtEvent: ['<string>'],
pipelinePhases: [],
crmPipelines: ['<string>'],
minStalledDays: 123,
minDealAmount: 123,
maxDealAmount: 123,
offerings: ['<string>'],
personas: ['<string>'],
segments: ['<string>'],
tags: ['<string>'],
useCases: ['<string>'],
references: ['<string>'],
competitors: ['<string>'],
alternatives: ['<string>'],
buyingTriggers: ['<string>'],
coreFeatures: ['<string>'],
objections: ['<string>'],
proofPoints: ['<string>'],
motionTypes: [],
callPurposes: [],
unmatchedOnly: true
},
exclude: {
eventCategories: [],
eventTypes: [],
sentiments: [],
contactEmails: ['<string>'],
companyDomains: ['<string>'],
outcomeFilters: [],
opportunityStatuses: [],
minDealAmount: 123,
maxDealAmount: 123,
offerings: ['<string>'],
personas: ['<string>'],
segments: ['<string>'],
tags: ['<string>'],
useCases: ['<string>'],
references: ['<string>'],
competitors: ['<string>'],
alternatives: ['<string>'],
buyingTriggers: ['<string>'],
coreFeatures: ['<string>'],
objections: ['<string>'],
proofPoints: ['<string>'],
motionTypes: [],
callPurposes: [],
dealMotions: [],
dealTypes: ['<string>'],
dealStages: ['<string>'],
pipelinePhases: []
},
excludeTags: ['<string>'],
metric: 'events',
rowLimit: 15,
columnLimit: 10
})
};
fetch('https://app.octavehq.com/api/v2/event/cross-tab', 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/cross-tab",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
'tagGroupOId' => '<string>'
],
'columns' => [
'tagGroupOId' => '<string>'
],
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'filters' => [
'entityMatchAll' => true,
'eventOIds' => [
'<string>'
],
'opportunityIds' => [
'<string>'
],
'eventCategories' => [
],
'eventTypes' => [
],
'sentiments' => [
],
'contactEmails' => [
'<string>'
],
'companyDomains' => [
'<string>'
],
'outcomeFilters' => [
],
'opportunityStatuses' => [
],
'dealMotions' => [
],
'dealTypes' => [
'<string>'
],
'dealStages' => [
'<string>'
],
'dealStagesAtEvent' => [
'<string>'
],
'pipelinePhases' => [
],
'crmPipelines' => [
'<string>'
],
'minStalledDays' => 123,
'minDealAmount' => 123,
'maxDealAmount' => 123,
'offerings' => [
'<string>'
],
'personas' => [
'<string>'
],
'segments' => [
'<string>'
],
'tags' => [
'<string>'
],
'useCases' => [
'<string>'
],
'references' => [
'<string>'
],
'competitors' => [
'<string>'
],
'alternatives' => [
'<string>'
],
'buyingTriggers' => [
'<string>'
],
'coreFeatures' => [
'<string>'
],
'objections' => [
'<string>'
],
'proofPoints' => [
'<string>'
],
'motionTypes' => [
],
'callPurposes' => [
],
'unmatchedOnly' => true
],
'exclude' => [
'eventCategories' => [
],
'eventTypes' => [
],
'sentiments' => [
],
'contactEmails' => [
'<string>'
],
'companyDomains' => [
'<string>'
],
'outcomeFilters' => [
],
'opportunityStatuses' => [
],
'minDealAmount' => 123,
'maxDealAmount' => 123,
'offerings' => [
'<string>'
],
'personas' => [
'<string>'
],
'segments' => [
'<string>'
],
'tags' => [
'<string>'
],
'useCases' => [
'<string>'
],
'references' => [
'<string>'
],
'competitors' => [
'<string>'
],
'alternatives' => [
'<string>'
],
'buyingTriggers' => [
'<string>'
],
'coreFeatures' => [
'<string>'
],
'objections' => [
'<string>'
],
'proofPoints' => [
'<string>'
],
'motionTypes' => [
],
'callPurposes' => [
],
'dealMotions' => [
],
'dealTypes' => [
'<string>'
],
'dealStages' => [
'<string>'
],
'pipelinePhases' => [
]
],
'excludeTags' => [
'<string>'
],
'metric' => 'events',
'rowLimit' => 15,
'columnLimit' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/event/cross-tab"
payload := strings.NewReader("{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/event/cross-tab")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/cross-tab")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"populations": {
"eventsInScope": 123,
"eventsWithARowValue": 123,
"eventsWithAColumnValue": 123,
"eventsWithBoth": 123
},
"relationshipGrain": "same_finding",
"rows": [
{
"key": "<string>",
"name": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
},
"cells": [
{
"columnKey": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
}
}
]
}
],
"columns": [
{
"key": "<string>",
"name": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
}
}
],
"dataWindow": {
"kind": "event_range",
"startDate": "<string>",
"endDate": "<string>",
"isDefault": true,
"periodType": "week"
},
"metric": "events"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Events
Event Cross-Tab
Cross two dimensions of the events matching a window and filters, such as objection x segment, and get event, company and deal metrics for every combination, each row and column, and the populations they are drawn from. Dimensions: a library entity type, a tag group, company, person, speaker_side, or deal_stage_at_event. relationshipGrain says whether a cell is co-occurrence in one conversation or the same finding. Cells overlap, so use populations for totals. REST twin of the get_event_cross_tab MCP tool.
POST
/
api
/
v2
/
event
/
cross-tab
Event Cross-Tab
curl --request POST \
--url https://app.octavehq.com/api/v2/event/cross-tab \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"rows": {
"tagGroupOId": "<string>"
},
"columns": {
"tagGroupOId": "<string>"
},
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"filters": {
"entityMatchAll": true,
"eventOIds": [
"<string>"
],
"opportunityIds": [
"<string>"
],
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"dealMotions": [],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"dealStagesAtEvent": [
"<string>"
],
"pipelinePhases": [],
"crmPipelines": [
"<string>"
],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"callPurposes": [],
"unmatchedOnly": true
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": [
"<string>"
],
"companyDomains": [
"<string>"
],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": [
"<string>"
],
"personas": [
"<string>"
],
"segments": [
"<string>"
],
"tags": [
"<string>"
],
"useCases": [
"<string>"
],
"references": [
"<string>"
],
"competitors": [
"<string>"
],
"alternatives": [
"<string>"
],
"buyingTriggers": [
"<string>"
],
"coreFeatures": [
"<string>"
],
"objections": [
"<string>"
],
"proofPoints": [
"<string>"
],
"motionTypes": [],
"callPurposes": [],
"dealMotions": [],
"dealTypes": [
"<string>"
],
"dealStages": [
"<string>"
],
"pipelinePhases": []
},
"excludeTags": [
"<string>"
],
"metric": "events",
"rowLimit": 15,
"columnLimit": 10
}
'import requests
url = "https://app.octavehq.com/api/v2/event/cross-tab"
payload = {
"rows": { "tagGroupOId": "<string>" },
"columns": { "tagGroupOId": "<string>" },
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"filters": {
"entityMatchAll": True,
"eventOIds": ["<string>"],
"opportunityIds": ["<string>"],
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": ["<string>"],
"companyDomains": ["<string>"],
"outcomeFilters": [],
"opportunityStatuses": [],
"dealMotions": [],
"dealTypes": ["<string>"],
"dealStages": ["<string>"],
"dealStagesAtEvent": ["<string>"],
"pipelinePhases": [],
"crmPipelines": ["<string>"],
"minStalledDays": 123,
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": ["<string>"],
"personas": ["<string>"],
"segments": ["<string>"],
"tags": ["<string>"],
"useCases": ["<string>"],
"references": ["<string>"],
"competitors": ["<string>"],
"alternatives": ["<string>"],
"buyingTriggers": ["<string>"],
"coreFeatures": ["<string>"],
"objections": ["<string>"],
"proofPoints": ["<string>"],
"motionTypes": [],
"callPurposes": [],
"unmatchedOnly": True
},
"exclude": {
"eventCategories": [],
"eventTypes": [],
"sentiments": [],
"contactEmails": ["<string>"],
"companyDomains": ["<string>"],
"outcomeFilters": [],
"opportunityStatuses": [],
"minDealAmount": 123,
"maxDealAmount": 123,
"offerings": ["<string>"],
"personas": ["<string>"],
"segments": ["<string>"],
"tags": ["<string>"],
"useCases": ["<string>"],
"references": ["<string>"],
"competitors": ["<string>"],
"alternatives": ["<string>"],
"buyingTriggers": ["<string>"],
"coreFeatures": ["<string>"],
"objections": ["<string>"],
"proofPoints": ["<string>"],
"motionTypes": [],
"callPurposes": [],
"dealMotions": [],
"dealTypes": ["<string>"],
"dealStages": ["<string>"],
"pipelinePhases": []
},
"excludeTags": ["<string>"],
"metric": "events",
"rowLimit": 15,
"columnLimit": 10
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: {tagGroupOId: '<string>'},
columns: {tagGroupOId: '<string>'},
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
filters: {
entityMatchAll: true,
eventOIds: ['<string>'],
opportunityIds: ['<string>'],
eventCategories: [],
eventTypes: [],
sentiments: [],
contactEmails: ['<string>'],
companyDomains: ['<string>'],
outcomeFilters: [],
opportunityStatuses: [],
dealMotions: [],
dealTypes: ['<string>'],
dealStages: ['<string>'],
dealStagesAtEvent: ['<string>'],
pipelinePhases: [],
crmPipelines: ['<string>'],
minStalledDays: 123,
minDealAmount: 123,
maxDealAmount: 123,
offerings: ['<string>'],
personas: ['<string>'],
segments: ['<string>'],
tags: ['<string>'],
useCases: ['<string>'],
references: ['<string>'],
competitors: ['<string>'],
alternatives: ['<string>'],
buyingTriggers: ['<string>'],
coreFeatures: ['<string>'],
objections: ['<string>'],
proofPoints: ['<string>'],
motionTypes: [],
callPurposes: [],
unmatchedOnly: true
},
exclude: {
eventCategories: [],
eventTypes: [],
sentiments: [],
contactEmails: ['<string>'],
companyDomains: ['<string>'],
outcomeFilters: [],
opportunityStatuses: [],
minDealAmount: 123,
maxDealAmount: 123,
offerings: ['<string>'],
personas: ['<string>'],
segments: ['<string>'],
tags: ['<string>'],
useCases: ['<string>'],
references: ['<string>'],
competitors: ['<string>'],
alternatives: ['<string>'],
buyingTriggers: ['<string>'],
coreFeatures: ['<string>'],
objections: ['<string>'],
proofPoints: ['<string>'],
motionTypes: [],
callPurposes: [],
dealMotions: [],
dealTypes: ['<string>'],
dealStages: ['<string>'],
pipelinePhases: []
},
excludeTags: ['<string>'],
metric: 'events',
rowLimit: 15,
columnLimit: 10
})
};
fetch('https://app.octavehq.com/api/v2/event/cross-tab', 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/cross-tab",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
'tagGroupOId' => '<string>'
],
'columns' => [
'tagGroupOId' => '<string>'
],
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'filters' => [
'entityMatchAll' => true,
'eventOIds' => [
'<string>'
],
'opportunityIds' => [
'<string>'
],
'eventCategories' => [
],
'eventTypes' => [
],
'sentiments' => [
],
'contactEmails' => [
'<string>'
],
'companyDomains' => [
'<string>'
],
'outcomeFilters' => [
],
'opportunityStatuses' => [
],
'dealMotions' => [
],
'dealTypes' => [
'<string>'
],
'dealStages' => [
'<string>'
],
'dealStagesAtEvent' => [
'<string>'
],
'pipelinePhases' => [
],
'crmPipelines' => [
'<string>'
],
'minStalledDays' => 123,
'minDealAmount' => 123,
'maxDealAmount' => 123,
'offerings' => [
'<string>'
],
'personas' => [
'<string>'
],
'segments' => [
'<string>'
],
'tags' => [
'<string>'
],
'useCases' => [
'<string>'
],
'references' => [
'<string>'
],
'competitors' => [
'<string>'
],
'alternatives' => [
'<string>'
],
'buyingTriggers' => [
'<string>'
],
'coreFeatures' => [
'<string>'
],
'objections' => [
'<string>'
],
'proofPoints' => [
'<string>'
],
'motionTypes' => [
],
'callPurposes' => [
],
'unmatchedOnly' => true
],
'exclude' => [
'eventCategories' => [
],
'eventTypes' => [
],
'sentiments' => [
],
'contactEmails' => [
'<string>'
],
'companyDomains' => [
'<string>'
],
'outcomeFilters' => [
],
'opportunityStatuses' => [
],
'minDealAmount' => 123,
'maxDealAmount' => 123,
'offerings' => [
'<string>'
],
'personas' => [
'<string>'
],
'segments' => [
'<string>'
],
'tags' => [
'<string>'
],
'useCases' => [
'<string>'
],
'references' => [
'<string>'
],
'competitors' => [
'<string>'
],
'alternatives' => [
'<string>'
],
'buyingTriggers' => [
'<string>'
],
'coreFeatures' => [
'<string>'
],
'objections' => [
'<string>'
],
'proofPoints' => [
'<string>'
],
'motionTypes' => [
],
'callPurposes' => [
],
'dealMotions' => [
],
'dealTypes' => [
'<string>'
],
'dealStages' => [
'<string>'
],
'pipelinePhases' => [
]
],
'excludeTags' => [
'<string>'
],
'metric' => 'events',
'rowLimit' => 15,
'columnLimit' => 10
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/event/cross-tab"
payload := strings.NewReader("{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/event/cross-tab")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/event/cross-tab")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"columns\": {\n \"tagGroupOId\": \"<string>\"\n },\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"filters\": {\n \"entityMatchAll\": true,\n \"eventOIds\": [\n \"<string>\"\n ],\n \"opportunityIds\": [\n \"<string>\"\n ],\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"dealStagesAtEvent\": [\n \"<string>\"\n ],\n \"pipelinePhases\": [],\n \"crmPipelines\": [\n \"<string>\"\n ],\n \"minStalledDays\": 123,\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"unmatchedOnly\": true\n },\n \"exclude\": {\n \"eventCategories\": [],\n \"eventTypes\": [],\n \"sentiments\": [],\n \"contactEmails\": [\n \"<string>\"\n ],\n \"companyDomains\": [\n \"<string>\"\n ],\n \"outcomeFilters\": [],\n \"opportunityStatuses\": [],\n \"minDealAmount\": 123,\n \"maxDealAmount\": 123,\n \"offerings\": [\n \"<string>\"\n ],\n \"personas\": [\n \"<string>\"\n ],\n \"segments\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"useCases\": [\n \"<string>\"\n ],\n \"references\": [\n \"<string>\"\n ],\n \"competitors\": [\n \"<string>\"\n ],\n \"alternatives\": [\n \"<string>\"\n ],\n \"buyingTriggers\": [\n \"<string>\"\n ],\n \"coreFeatures\": [\n \"<string>\"\n ],\n \"objections\": [\n \"<string>\"\n ],\n \"proofPoints\": [\n \"<string>\"\n ],\n \"motionTypes\": [],\n \"callPurposes\": [],\n \"dealMotions\": [],\n \"dealTypes\": [\n \"<string>\"\n ],\n \"dealStages\": [\n \"<string>\"\n ],\n \"pipelinePhases\": []\n },\n \"excludeTags\": [\n \"<string>\"\n ],\n \"metric\": \"events\",\n \"rowLimit\": 15,\n \"columnLimit\": 10\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"populations": {
"eventsInScope": 123,
"eventsWithARowValue": 123,
"eventsWithAColumnValue": 123,
"eventsWithBoth": 123
},
"relationshipGrain": "same_finding",
"rows": [
{
"key": "<string>",
"name": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
},
"cells": [
{
"columnKey": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
}
}
]
}
],
"columns": [
{
"key": "<string>",
"name": "<string>",
"metrics": {
"events": 123,
"uniqueCompanies": 123,
"uniqueDeals": 123,
"wonDeals": 123,
"lostDeals": 123,
"knownWonValue": 123,
"wonDealsWithValue": 123,
"wonDealsValueMissing": 123,
"wonDealsValueUnconverted": 123,
"negativeValueWonDeals": {
"deals": 123,
"amount": 123
},
"winRate": {
"closedDeals": 123,
"rate": 123,
"low": 123,
"high": 123,
"sampleSizeBand": "insufficient"
}
}
}
],
"dataWindow": {
"kind": "event_range",
"startDate": "<string>",
"endDate": "<string>",
"isDefault": true,
"periodType": "week"
},
"metric": "events"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Event window, filters, and the row and column dimensions
The dimension down the side. One row per value, ranked by metric.
Show child attributes
Show child attributes
The dimension across the top. Every row is split by its values.
Show child attributes
Show child attributes
Start date for event time range (ISO 8601 format). Defaults to 14 days ago if not provided; the response's dataWindow echoes what was used.
End date for event time range. Defaults to the time of the request, so events stamped in the future (a lost deal's placeholder close date, for example) are left out; pass an explicit later endDate to include them. The response's dataWindow echoes what was used.
Filters to INCLUDE events: event type/category, company, contact, sentiment, call purpose, outcome, deal amount, library entity oIds (offerings, personas, segments, tags, use cases, competitors, alternatives, buying triggers, core features, objections, proof points, references), motion types, customer scope, and CRM deal context (opportunityIds, opportunityStatuses, dealMotions, dealTypes, dealStages, pipelinePhases, crmPipelines, minStalledDays). Deal filters AND on the same linked deal; values within one filter are OR'd.
Show child attributes
Show child attributes
Filters to EXCLUDE events matching these criteria (same shape as the entity/outcome match filters)
Show child attributes
Show child attributes
Exclude events matching any library entity that carries these reporting tag oIds. Use list_tag_groups to resolve tag oIds. Multiple tags are OR'd.
What to rank by. events = distinct matching events; uniqueCompanies = distinct companies on them; uniqueDeals / wonDeals / lostDeals = distinct CRM deals linked to them (any / closed-won / closed-lost today); knownWonValue = summed home-currency value of the won deals whose value is known and not negative (a group with none known ranks last); winRateSampleAdjusted = win rate, ranked by the LOW end of each group's 95% interval (winRate.low) so a small sample cannot top the list — 2 won of 2 ranks below 40 won of 60. Use it for 'which of these wins most'; the plain winRate.rate is on every group but is not offered as a ranking because it rewards tiny samples. Groups with no closed deals rank last. Every metric is returned on every group — this only picks the ordering.
Available options:
events, uniqueCompanies, uniqueDeals, wonDeals, lostDeals, knownWonValue, winRateSampleAdjusted Row groups to return, ranked by metric (default 15, max 50).
Required range:
1 <= x <= 50Column groups to return, ranked by metric (default 10, max 25).
Required range:
1 <= x <= 25Response
Event Cross-Tab
Show child attributes
Show child attributes
What the table is drawn from. An event can carry several values of a dimension, so rows, columns and cells OVERLAP: never add them up to get a total — these are the totals. Only the top rowLimit / columnLimit groups are listed, so listed groups can cover less than these.
Show child attributes
Show child attributes
What a CELL means when rows are crossed with columns. same_event: both values occur somewhere in the same conversation — co-occurrence, NOT that one was said about the other, and never who said it (the 'person' dimension is who attended). same_finding: speaker_side crossed with an entity type or tag group — the side is read off the very finding that matched the entity, so 'objection X × external' means a buyer-side finding raised X. There, 'unknown' is a finding type that records no speaker, and speaker_side totals cover only that dimension's findings. Whatever the grain, every metric still counts distinct events, companies and deals — never findings. Null without columns.
Available options:
same_finding, same_event, null Show child attributes
Show child attributes
The column groups, ranked; empty when no columns dimension was requested.
Show child attributes
Show child attributes
The time span these numbers cover. Compare numbers from two tools only when their dataWindow kind and dates match.
Show child attributes
Show child attributes
What to rank by. events = distinct matching events; uniqueCompanies = distinct companies on them; uniqueDeals / wonDeals / lostDeals = distinct CRM deals linked to them (any / closed-won / closed-lost today); knownWonValue = summed home-currency value of the won deals whose value is known and not negative (a group with none known ranks last); winRateSampleAdjusted = win rate, ranked by the LOW end of each group's 95% interval (winRate.low) so a small sample cannot top the list — 2 won of 2 ranks below 40 won of 60. Use it for 'which of these wins most'; the plain winRate.rate is on every group but is not offered as a ranking because it rewards tiny samples. Groups with no closed deals rank last. Every metric is returned on every group — this only picks the ordering.
Available options:
events, uniqueCompanies, uniqueDeals, wonDeals, lostDeals, knownWonValue, winRateSampleAdjusted