Export VOC conversations (reporting)

List VOC conversations (reporting format)

curl --request GET \
  --url https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations', 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://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "cursor": {
    "next": "<string>"
  },
  "data": [
    {
      "ID": "<string>",
      "TenantID": "<string>",
      "Datetime": "2023-11-07T05:31:56Z",
      "DatetimeUTC": "2023-11-07T05:31:56Z",
      "Duration": 123,
      "Direction": "<string>",
      "Media": "<string>",
      "AgentName": "<string>",
      "AgentId": "<string>",
      "AgentEmail": "<string>",
      "CustomerName": "<string>",
      "CustomerId": "<string>",
      "CustomerEmail": "<string>",
      "Groups": "<string>",
      "Tags": "<string>",
      "Category": "<string>",
      "Subcategory": "<string>",
      "Tertiary": "<string>",
      "CategoryExplanation": "<string>",
      "CategoriesId": "<string>",
      "Summary": "<string>",
      "CSat": 123,
      "CSatExplanation": "<string>",
      "Sentiment": 123,
      "SentimentExplanation": "<string>",
      "Problems": [
        {}
      ],
      "KPIs": [
        {}
      ],
      "SourceSystem": "<string>",
      "TicketId": "<string>",
      "TicketUrl": "<string>"
    }
  ]
}

{
  "code": "BadRequest",
  "message": "Invalid request parameters"
}

{
  "code": "Unauthenticated",
  "message": "Authorization header with Bearer token is required"
}

{
  "code": "PermissionDenied",
  "message": "API key does not allow this operation"
}

{
  "code": "Unavailable",
  "message": "Elastic search failed"
}

GET

api

reporting

tenants

{tenantId}

voc

conversations

List VOC conversations (reporting format)

curl --request GET \
  --url https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations', 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://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.crescendo.ai/api/v1/reporting/tenants/{tenantId}/voc/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "cursor": {
    "next": "<string>"
  },
  "data": [
    {
      "ID": "<string>",
      "TenantID": "<string>",
      "Datetime": "2023-11-07T05:31:56Z",
      "DatetimeUTC": "2023-11-07T05:31:56Z",
      "Duration": 123,
      "Direction": "<string>",
      "Media": "<string>",
      "AgentName": "<string>",
      "AgentId": "<string>",
      "AgentEmail": "<string>",
      "CustomerName": "<string>",
      "CustomerId": "<string>",
      "CustomerEmail": "<string>",
      "Groups": "<string>",
      "Tags": "<string>",
      "Category": "<string>",
      "Subcategory": "<string>",
      "Tertiary": "<string>",
      "CategoryExplanation": "<string>",
      "CategoriesId": "<string>",
      "Summary": "<string>",
      "CSat": 123,
      "CSatExplanation": "<string>",
      "Sentiment": 123,
      "SentimentExplanation": "<string>",
      "Problems": [
        {}
      ],
      "KPIs": [
        {}
      ],
      "SourceSystem": "<string>",
      "TicketId": "<string>",
      "TicketUrl": "<string>"
    }
  ]
}

{
  "code": "BadRequest",
  "message": "Invalid request parameters"
}

{
  "code": "Unauthenticated",
  "message": "Authorization header with Bearer token is required"
}

{
  "code": "PermissionDenied",
  "message": "API key does not allow this operation"
}

{
  "code": "Unavailable",
  "message": "Elastic search failed"
}

This endpoint returns VOC conversations as reporting rows (no transcript content), suitable for exporting large time ranges.

Date range filtering

You can specify a time range using either:

range=last_day|last_week|last_month, or
from / to (ISO 8601 or epoch millis)

If you do not supply a range, the default is range=last_day.

Pagination (cursor)

Results are paginated using an opaque cursor:

Use limit to control page size (default 1000, max 5000)
Use cursor to fetch the next page (from cursor.next)
When you supply cursor, do not also supply range, from, or to

Example: first page

export CRESCENDO_TENANT_ID="tenant-alpha"
export CRESCENDO_API_KEY="YOUR_API_KEY"

curl -sS \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  "https://platform.crescendo.ai/api/v1/reporting/tenants/$CRESCENDO_TENANT_ID/voc/conversations?range=last_month&limit=1000"

Example: next page

export CURSOR="PASTE_cursor.next_HERE"

curl -sS -G \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  --data-urlencode "cursor=$CURSOR" \
  "https://platform.crescendo.ai/api/v1/reporting/tenants/$CRESCENDO_TENANT_ID/voc/conversations"

Example: fetch all pages (Node.js)

const baseUrl = 'https://platform.crescendo.ai';

async function fetchAllVocconv({ tenantId, apiKey, limit = 1000, range = 'last_month' }) {
  const allRows = [];

  let cursor = null;
  let first = true;

  while (true) {
    const url = new URL(`${baseUrl}/api/v1/reporting/tenants/${tenantId}/voc/conversations`);

    if (first) {
      url.searchParams.set('range', range);
      url.searchParams.set('limit', String(limit));
      first = false;
    } else {
      url.searchParams.set('cursor', cursor);
      url.searchParams.set('limit', String(limit));
    }

    const res = await fetch(url, {
      headers: { Authorization: `Bearer ${apiKey}` },
    });
    if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);

    const body = await res.json();
    allRows.push(...(body.data ?? []));

    cursor = body?.cursor?.next;
    if (!cursor) break;
  }

  return allRows;
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenantId

string

required

Tenant identifier.

Query Parameters

limit

integer<int32>

Max results per page. Default 1000, max 5000.

Required range: 1 <= x <= 5000

cursor

string

Opaque cursor returned in cursor.next. When provided, do not also supply range, from, or to.

range

enum<string>

Convenience range selector. If omitted and from is omitted, defaults to last_day.

Available options:

last_day,

last_week,

last_month

from

Range start. Accepts an ISO 8601 timestamp or epoch milliseconds. Epoch milliseconds.

Range end. Accepts an ISO 8601 timestamp or epoch milliseconds. Defaults to now. Epoch milliseconds.

Response

total

integer<int64>

required

cursor

object

required

Show child attributes

data

object[]

required

Show child attributes

⌘I

Overview

Provisioning

Reporting

VOC

MCP

Date range filtering

Example: first page

Example: next page

Example: fetch all pages (Node.js)

Authorizations

Path Parameters

Query Parameters

Response

​Date range filtering

​Pagination (cursor)

​Example: first page

​Example: next page

​Example: fetch all pages (Node.js)

Authorizations

Path Parameters

Query Parameters

Response

Date range filtering

Pagination (cursor)

Example: first page

Example: next page

Example: fetch all pages (Node.js)