v3

latestOpenAPI 3.1.02026-08-0150254154.0 KB

manage > v1 > projects > usage

Get Project Usage

Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.

get/v1/projects/{project_id}/usage

Path parameters

project_idstring required

The unique identifier of the project

Query parameters

startstring date

Start date of the requested date range. Format accepted is YYYY-MM-DD

endstring date

End date of the requested date range. Format accepted is YYYY-MM-DD

accessorstring

Filter for requests where a specific accessor was used

alternativesboolean

Filter for requests where alternatives were used

callback_methodboolean

Filter for requests where callback method was used

callbackboolean

Filter for requests where callback was used

channelsboolean

Filter for requests where channels were used

custom_intent_modeboolean

Filter for requests where custom intent mode was used

custom_intentboolean

Filter for requests where custom intent was used

custom_topic_modeboolean

Filter for requests where custom topic mode was used

custom_topicboolean

Filter for requests where custom topic was used

deployment'hosted' | 'beta' | 'self-hosted'

Deployment type for the requests

Filter for requests where a specific deployment was used

detect_entitiesboolean

Filter for requests where detect entities was used

detect_languageboolean

Filter for requests where detect language was used

diarizeboolean

Filter for requests where diarize was used

dictationboolean

Filter for requests where dictation was used

encodingboolean

Filter for requests where encoding was used

endpoint'listen' | 'read' | 'speak' | 'agent'

Filter for requests where a specific endpoint was used

extraboolean

Filter for requests where extra was used

filler_wordsboolean

Filter for requests where filler words was used

intentsboolean

Filter for requests where intents was used

keytermboolean

Filter for requests where keyterm was used

keywordsboolean

Filter for requests where keywords was used

languageboolean

Filter for requests where language was used

measurementsboolean

Filter for requests where measurements were used

method'sync' | 'async' | 'streaming'

Method type for the request

Filter for requests where a specific method was used

modelstring

Filter for requests where a specific model uuid was used

multichannelboolean

Filter for requests where multichannel was used

numeralsboolean

Filter for requests where numerals were used

paragraphsboolean

Filter for requests where paragraphs were used

profanity_filterboolean

Filter for requests where profanity filter was used

punctuateboolean

Filter for requests where punctuate was used

redactboolean

Filter for requests where redact was used

replaceboolean

Filter for requests where replace was used

sample_rateboolean

Filter for requests where sample rate was used

searchboolean

Filter for requests where search was used

sentimentboolean

Filter for requests where sentiment was used

smart_formatboolean

Filter for requests where smart format was used

summarizeboolean

Filter for requests where summarize was used

tagstring

Filter for requests where a specific tag was used

topicsboolean

Filter for requests where topics was used

utt_splitboolean

Filter for requests where utt split was used

utterancesboolean

Filter for requests where utterances was used

versionboolean

Filter for requests where version was used

Headers

Authorizationstring required

Use Authorization: Token <API_KEY> Example: Authorization: Token 12345abcdef

Response

A specific request for a specific project

startstring date

endstring date