Skip to main content

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.

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