---
title: "Query Simulated Conversations"
method: GET
path: "/v1/simulated-conversations"
tags: ["Simulated Conversations"]
---

# Query Simulated Conversations

`GET /v1/simulated-conversations`

## Request

- Base URL: `https://api.getbluejay.ai`
- URL: `https://api.getbluejay.ai/v1/simulated-conversations`
- Auth: `HTTPBearer` (a scheme the document does not define)

How many simulated conversations, and how they break down by status, agent,
simulation, run, digital human, day, or how one metric came out.

## Query parameters

- `status` string[], nullable: e.g. COMPLETED, SYSTEM_ERROR, NO_ANSWER
- `agent_ids` integer[], nullable
- `simulation_ids` integer[], nullable
- `simulation_run_ids` integer[], nullable
- `group_by` 'status' | 'agent' | 'simulation' | 'run' | 'digital_human' | 'day' | 'metric_value', nullable: Omit for totals; set for counts per group
- `metric_name` string, nullable: Required when group_by is metric_value
- `metric_id` string, uuid, nullable
- `last` '1day' | '3days' | '7days' | '30days' | '90days' | 'all', nullable: By when the conversation was created. Omitted: all time when filtering by a run, simulation or agent, otherwise the last 7 days

## Headers

- `X-Organization-Id` string
- `X-API-Key` string, required

## Response `200`

Successful Response

- SimulatedConversationsResponse
  - `total` integer, required: Simulated conversations matching the filters (scored ones for metric_value)
  - `runs` integer, required: Distinct simulation runs among them
  - `since` string, date-time, nullable: Start of the window; None for all time
  - `group_by` string, nullable
  - `breakdown` SimBucket[]
    - `group` string, required: The grouped value, or the metric value when grouping by it
    - `name` string, nullable: Agent or simulation name; for a run, its simulation's
    - `started_at` string, date-time, nullable: Runs only: when the run was created
    - `conversations` integer, required
    - `runs` integer, required: Distinct simulation runs among these conversations
    - `edited_count` integer, nullable: Metric groupings only: human-corrected results
  - `groups_truncated` boolean: True when more groups matched than were returned
  - `metric_name` string, nullable
  - `metric_type` string, nullable
  - `not_applicable` integer, nullable: metric_value only: results that did not apply
  - `average` number, nullable: metric_value on a numeric metric only

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-27** `aab8058a16e0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getbluejay/apis/bluejay-api/changes/v1/simulated-conversations/get.md)

---

[API](https://skmtc.dev/getbluejay/apis/bluejay-api.md) - [All operations](https://skmtc.dev/getbluejay/apis/bluejay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getbluejay/apis/bluejay-api/revisions/6882bf5e63d5?raw)
