getUsageSummary

Returns a summary of document retrieval queries for the authenticated organization within a date range.

Queries are categorized as TEFCA (queries through TEFCA network) or non-TEFCA. The response also includes active users and query counts for each Pacific calendar month touched by the date range.

Query Parameters
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 Usage summary for the organization Schema — OPTIONAL tefcaQueries number Total number of TEFCA queries nonTefcaQueries number Total number of non-TEFCA queries totalQueries number Total number of queries monthlyUsage object[] Usage grouped by Pacific calendar month month string Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[0-2])$ Pacific calendar month activeUsers number Number of active users tefcaQueries number Number of TEFCA queries nonTefcaQueries number Number of non-TEFCA queries totalQueries number Total number of queries queriesBySource object[] Query counts by source category source string Possible values: [TEFCA, FASTEN, PARTICLE, HEALTHEX_EPIC, HEALTHEX_ORACLE, HEALTHEX_ECW, HEALTHEX_ATHENA] Query source category queries number Number of queries for this source