curl --request POST \
--url https://apiv2.vodex.ai/v1/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"outcomes": [
"<string>"
],
"recipients": [
"jsmith@example.com"
],
"digestTime": "06:00",
"digestTimezone": "Asia/Kolkata",
"digestWindowHours": 24
}
'import requests
url = "https://apiv2.vodex.ai/v1/reports"
payload = {
"name": "<string>",
"outcomes": ["<string>"],
"recipients": ["jsmith@example.com"],
"digestTime": "06:00",
"digestTimezone": "Asia/Kolkata",
"digestWindowHours": 24
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
outcomes: ['<string>'],
recipients: ['jsmith@example.com'],
digestTime: '06:00',
digestTimezone: 'Asia/Kolkata',
digestWindowHours: 24
})
};
fetch('https://apiv2.vodex.ai/v1/reports', 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://apiv2.vodex.ai/v1/reports",
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([
'name' => '<string>',
'outcomes' => [
'<string>'
],
'recipients' => [
'jsmith@example.com'
],
'digestTime' => '06:00',
'digestTimezone' => 'Asia/Kolkata',
'digestWindowHours' => 24
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://apiv2.vodex.ai/v1/reports"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://apiv2.vodex.ai/v1/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"outcomes": [
"<string>"
],
"mode": "scheduled",
"recipients": [
"jsmith@example.com"
],
"digestTime": "<string>",
"digestTimezone": "<string>",
"digestWindowHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}Create a report
Instant reports email — and, when the tenant has a webhook URL, emit a
report.instant event — the moment a call reaches one of their outcomes.
Scheduled reports send one daily digest at digestTime over the last
digestWindowHours (and a report.digest event). Recipients live on the
report, so the same outcome can route to different teams.
curl --request POST \
--url https://apiv2.vodex.ai/v1/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"outcomes": [
"<string>"
],
"recipients": [
"jsmith@example.com"
],
"digestTime": "06:00",
"digestTimezone": "Asia/Kolkata",
"digestWindowHours": 24
}
'import requests
url = "https://apiv2.vodex.ai/v1/reports"
payload = {
"name": "<string>",
"outcomes": ["<string>"],
"recipients": ["jsmith@example.com"],
"digestTime": "06:00",
"digestTimezone": "Asia/Kolkata",
"digestWindowHours": 24
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
outcomes: ['<string>'],
recipients: ['jsmith@example.com'],
digestTime: '06:00',
digestTimezone: 'Asia/Kolkata',
digestWindowHours: 24
})
};
fetch('https://apiv2.vodex.ai/v1/reports', 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://apiv2.vodex.ai/v1/reports",
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([
'name' => '<string>',
'outcomes' => [
'<string>'
],
'recipients' => [
'jsmith@example.com'
],
'digestTime' => '06:00',
'digestTimezone' => 'Asia/Kolkata',
'digestWindowHours' => 24
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://apiv2.vodex.ai/v1/reports"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://apiv2.vodex.ai/v1/reports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"outcomes\": [\n \"<string>\"\n ],\n \"recipients\": [\n \"jsmith@example.com\"\n ],\n \"digestTime\": \"06:00\",\n \"digestTimezone\": \"Asia/Kolkata\",\n \"digestWindowHours\": 24\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"outcomes": [
"<string>"
],
"mode": "scheduled",
"recipients": [
"jsmith@example.com"
],
"digestTime": "<string>",
"digestTimezone": "<string>",
"digestWindowHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
Create/update body. digestTime and digestTimezone are required when mode is scheduled.
801scheduled, instant "06:00"
"Asia/Kolkata"
1 <= x <= 168Response
The created report.
A named call summary. instant delivers the moment a call reaches one of
outcomes; scheduled sends one daily digest at digestTime over the
last digestWindowHours. Delivery is by email (to recipients) and, when
the tenant has a webhook URL, also as a report.instant / report.digest
webhook event — so a report with no recipients is a valid webhook-only one.
Unique within the workspace.
Outcome keys this report covers (the stable id, not the display name).
scheduled, instant Emails this report sends to. May be empty (webhook-only).
HH:MM 24-hour; scheduled only.
IANA zone; scheduled only.
1–168; scheduled only.