Build with your
call data.

01 / Authentication

Check account access first.

Sign in to Trellus and open Settings → Integrations → API. Copy your account key there. The complete reference, examples and field catalogue are available publicly on this website. If the page is unavailable, ask your team admin to check your access or contact support.

Store the key in your server environment as TRELLUS_API_KEY. It belongs to your signed-in account and inherits that account’s permissions; using it for reporting does not create a separately restricted credential.

curl https://ext.trellus.ai/visible \
  -H "api_key: $TRELLUS_API_KEY"

These examples use a placeholder environment variable. This page never asks for a key or sends a request to the API.

02 / Your first query

Choose a date window. List your calls.

Start with a small result set. The example selects calls and returns their IDs, start times, contact names, and durations. You can include transcript columns when your project needs them.

curl https://rpt-2.trellus.ai/session-list-v6 \
  -H "Authorization: Bearer $TRELLUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start": 1790812800000000,
  "end": 1791417600000000,
  "cnf": [
    [
      {
        "column_name": "conversation_type",
        "operator": "EQ",
        "value_safe": 1
      }
    ]
  ],
  "limit": 50,
  "select": [
    "session_id",
    "started_at",
    "customer_data.name",
    "duration"
  ]
}'

03 / Response shape

Map each row to your selected fields.

List results are arrays of rows. Every cell matches the field at the same position in your request’s select array. A successful empty response, [], means no readable calls matched that query.

[
  [
    "EXAMPLE_SESSION_ID",
    1790812800,
    "Example contact",
    120
  ]
]

// Each row follows the same order as your request's select array.
const calls = rows.map(row => Object.fromEntries(
  select.map((column, index) => [column, row[index]])
));

// started_at and duration are seconds, unlike request date boundaries.
const startedAt = calls[0] ? new Date(calls[0].started_at * 1000) : null;

Contact fields depend on captured CRM data. Transcripts depend on the call’s recording and transcription settings. When transcript arrays are present, match their entries by index.

04 / Call detail

Read one selected call.

Use an exact session_id from your list response in the x-session-id header. Keep the same account key. The x-proto-as-json header requests JSON instead of the default binary format.

curl https://rpt-2.trellus.ai/session \
  -H "Authorization: Bearer $TRELLUS_API_KEY" \
  -H "x-session-id: SESSION_ID_FROM_YOUR_LIST" \
  -H "x-proto-as-json: true"

Detail JSON uses camelCase names such as customerData and turnData. List-query fields use snake_case paths such as customer_data.name. Default-valued fields may be absent in detail JSON.

Before you schedule a job

Keep queries bounded and results checkable.

The full Call Data API reference also covers filtered counts and duration totals, recording links, the complete field catalogue, and an OpenAPI starter.