Skip to main content

getUsageDetails

Returns paginated patient-level usage details for the authenticated organization within a date range.

Each patient entry shows the number of TEFCA and non-TEFCA queries.

Query Parameters
pageSize number

Results per page (default: 20, max: 100)

page number

Page number (default: 1)

endDate date-time REQUIRED

End date for the usage period (ISO 8601)

startDate date-time REQUIRED

Start date for the usage period (ISO 8601)

Responses
200

Paginated patient usage details

Schema OPTIONAL
total number

Total number of patients with queries

page number

Current page number

pageSize number

Number of results per page

results array[]

Patient usage details