Unfortunately, the Heidi API and Widget are no longer available for future integrations in Australia and New Zealand. If you are a current Heidi customer looking to integrate, reach out to your Customer Success representative. Otherwise, contact our team to find out what this means for you.
Usage API (Beta)
Queries

Queries

The Usage API exposes a fixed set of named queries. Pass the query name in the POST body; each query has a fixed, documented column shape returned in data as a list of rows keyed by column name.

🚧 Beta. The query catalogue is expanding. One query is available today.

user_daily_report

Per-user, per-day activity for your organization — sessions, transcribed and dictated minutes, consult notes, documents, and tasks. Org-scoped: only your organization's data is returned.

Request body

FieldTypeNotes
namestring (required)"user_daily_report"
limitintRows per page. Server max: 2000.
params.sincestring YYYY-MM-DDOptional lower bound (inclusive).
params.untilstring YYYY-MM-DDOptional upper bound (inclusive).

Date semantics

  • Neither since nor until → the latest report date only (1-day window).
  • since only → from since through the latest report date.
  • until only → from the earliest available date up to until.
  • Both → inclusive range.
  • until < since → 422 INVALID_DATE_RANGE.

Example

POST /api/v1/usage
Heidi-Api-Key: <your api key>
Content-Type: application/json
 
{
  "name": "user_daily_report",
  "limit": 500,
  "params": { "since": "2026-06-01", "until": "2026-06-30" }
}

Each row corresponds to one user on one report_date, with activity counts and minutes for that day. Follow next_page_url to page through the full result set (see Overview → Request lifecycle).

OverviewOverview