Get the customer-readable trace for a v2 conversation, nested Session→Turn→node→step

GET

conversations

{conversation_id}

trace

grouped

Get the customer-readable trace for a v2 conversation, nested Session→Turn→node→step

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped', 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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "session": [
    {
      "kind": "<string>",
      "actor": "Customer",
      "title": "<string>",
      "status": "Succeeded",
      "started_at": "2023-11-07T05:31:56Z",
      "summary": "<string>",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "turn_id": "<string>",
      "details": {}
    }
  ],
  "turns": [
    {
      "turn_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "groups": [
        {
          "steps": [
            {
              "kind": "<string>",
              "actor": "Customer",
              "title": "<string>",
              "status": "Succeeded",
              "started_at": "2023-11-07T05:31:56Z",
              "summary": "<string>",
              "ended_at": "2023-11-07T05:31:56Z",
              "duration_ms": 123,
              "turn_id": "<string>",
              "details": {}
            }
          ],
          "node": "<string>"
        }
      ],
      "customer_message": "<string>",
      "ttft_ms": 123,
      "duration_ms": 123
    }
  ],
  "header": {
    "channel": "<string>",
    "customer": "<string>",
    "agent": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "outcome": "<string>",
    "memory": "<string>"
  },
  "next_cursor": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

conversation_id

string<uuid>

required

Query Parameters

turn_id

string<uuid> | null

cursor

string | null

Turn-pagination cursor: pass the previous page's next_cursor to load the next block of turns. Omit for the first page.

limit

integer

default:25

Max TURNS per page (the grouped tree paginates by turn, not by raw step).

Required range: 1 <= x <= 200

Response

Successful Response

Nested envelope (Phase D): Session → Turn → node → step.

header holds the session-level facts (who / channel / agent / outcome / memory) shown once. session holds any remaining session-lane steps not folded into the header. turns holds the per-turn trees, ordered by turn start. A read alternative to the flat :class:SessionTraceResponse; the flat shape stays for back-compat.

session

TraceStep · object[]

required

Show child attributes

turns

TraceTurn · object[]

required

Show child attributes

header

TraceSessionHeader · object | null

Session-level facts shown ONCE at the top of the trace (never repeated per turn).

Derived from the conversation row + the session-lane steps, so the timeline opens with a single 'who / what / outcome' block instead of burying identity / memory / start / end events inside the turn stream.

Show child attributes

next_cursor

string | null

Get the customer-readable trace for a v2 conversation, nested Session→Turn→node→step

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped', 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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api-sandbox.featherhq.com/v1/conversations/{conversation_id}/trace/grouped")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "session": [
    {
      "kind": "<string>",
      "actor": "Customer",
      "title": "<string>",
      "status": "Succeeded",
      "started_at": "2023-11-07T05:31:56Z",
      "summary": "<string>",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "turn_id": "<string>",
      "details": {}
    }
  ],
  "turns": [
    {
      "turn_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "groups": [
        {
          "steps": [
            {
              "kind": "<string>",
              "actor": "Customer",
              "title": "<string>",
              "status": "Succeeded",
              "started_at": "2023-11-07T05:31:56Z",
              "summary": "<string>",
              "ended_at": "2023-11-07T05:31:56Z",
              "duration_ms": 123,
              "turn_id": "<string>",
              "details": {}
            }
          ],
          "node": "<string>"
        }
      ],
      "customer_message": "<string>",
      "ttft_ms": 123,
      "duration_ms": 123
    }
  ],
  "header": {
    "channel": "<string>",
    "customer": "<string>",
    "agent": "<string>",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "outcome": "<string>",
    "memory": "<string>"
  },
  "next_cursor": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}