Skip to content

Get Voice Ai Dashboard

GET
/agency/reports/voice-ai/dashboard

Voice AI totals, per-client summary and daily trend.

The app calls this route dashboard-v2. An iteration number is an internal fact about how the report was built, not something a customer should have to type, so it is published as dashboard - there is no v1 in this contract for it to be confused with.

Authorizations

Parameters

Query Parameters

start_date
required

Start date, YYYY-MM-DD.

string

Start date, YYYY-MM-DD.

end_date
required

End date, YYYY-MM-DD.

string

End date, YYYY-MM-DD.

org_filter
Any of:
string

Narrow to ONE client org. Silently ignored when it names an org outside this agency’s authorized set - it can select within the set, never widen it.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An OPEN envelope around one report’s answer.

The app wraps every one of these reports in {success, data, meta}, where meta carries the cache state, the window and - on the agency reports - failed_org_ids, the orgs that contributed NOTHING to the totals above. That field is the difference between “this client sent no email” and “we could not query this client”, so it is forwarded rather than flattened away.

Open on purpose: data is dict | list in the app and its contents grow with the product. A closed model would turn every new metric into a silently dropped one.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string