GEgetbluejay
Simulated Conversations

Query Simulated Conversations

Changed on

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

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)

Query parameters

statusstring[] nullable

e.g. COMPLETED, SYSTEM_ERROR, NO_ANSWER

agent_idsinteger[] nullable
simulation_idsinteger[] nullable
simulation_run_idsinteger[] nullable
group_by'status' | 'agent' | 'simulation' | 'run' | 'digital_human' | 'day' | 'metric_value' nullable

Omit for totals; set for counts per group

metric_namestring nullable

Required when group_by is metric_value

metric_idstring 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-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

totalinteger required

Simulated conversations matching the filters (scored ones for metric_value)

runsinteger required

Distinct simulation runs among them

sincestring date-time nullable

Start of the window; None for all time

group_bystring nullable
groups_truncatedboolean

True when more groups matched than were returned

metric_namestring nullable
metric_typestring nullable
not_applicableinteger nullable

metric_value only: results that did not apply

averagenumber nullable

metric_value on a numeric metric only

Changes