v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-032765158.3 KB
Usage

Get Document Usage

Document usage analytics (added/deleted/parsed/indexed events).

post/usage/documents

Request body

start_timeinteger required

Start time for the usage query (inclusive) - Unix timestamp (seconds since epoch)

end_timeinteger required

End time for the usage query (inclusive) - Unix timestamp (seconds since epoch)

aggregation_window'minutely' | 'hourly' | 'daily' required
collection_namesstring[] nullable

Optional list of collection names to filter by. If None, returns data for all collections.

Response

Successful Response

window_startinteger required
organization_idstring uuid required
collection_idstring uuid required
event_type'added' | 'deleted' | 'parsed' | 'indexed' required
event_countinteger required
total_file_size_bytesinteger required
total_content_tokensinteger required
total_llm_tokensinteger required
total_embedding_tokensinteger required
total_coarse_chunksinteger required
total_fine_chunksinteger required
total_pagesinteger required
total_time_taken_msnumber required