API ReferenceManagement APIUsage

Get Project Usage

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

Path parameters

project_idstringRequired
The unique identifier of the project

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Query parameters

startstringOptionalformat: "date"

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

endstringOptionalformat: "date"

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

accessorstringOptional
Filter for requests where a specific accessor was used
alternativesbooleanOptional
Filter for requests where alternatives were used
callback_methodbooleanOptional
Filter for requests where callback method was used
callbackbooleanOptional
Filter for requests where callback was used
channelsbooleanOptional
Filter for requests where channels were used
custom_intent_modebooleanOptional
Filter for requests where custom intent mode was used
custom_intentbooleanOptional
Filter for requests where custom intent was used
custom_topic_modebooleanOptional
Filter for requests where custom topic mode was used
custom_topicbooleanOptional
Filter for requests where custom topic was used
deploymentenumOptional
Filter for requests where a specific deployment was used
Allowed values:
detect_entitiesbooleanOptional
Filter for requests where detect entities was used
detect_languagebooleanOptional
Filter for requests where detect language was used
diarizebooleanOptional
Filter for requests where diarize was used
dictationbooleanOptional
Filter for requests where dictation was used
encodingbooleanOptional
Filter for requests where encoding was used
endpointenumOptional
Filter for requests where a specific endpoint was used
Allowed values:
extrabooleanOptional
Filter for requests where extra was used
filler_wordsbooleanOptional
Filter for requests where filler words was used
intentsbooleanOptional
Filter for requests where intents was used
keytermbooleanOptional
Filter for requests where keyterm was used
keywordsbooleanOptional
Filter for requests where keywords was used
languagebooleanOptional
Filter for requests where language was used
measurementsbooleanOptional
Filter for requests where measurements were used
methodenumOptional
Filter for requests where a specific method was used
Allowed values:
modelstringOptional
Filter for requests where a specific model uuid was used
multichannelbooleanOptional
Filter for requests where multichannel was used
numeralsbooleanOptional
Filter for requests where numerals were used
paragraphsbooleanOptional
Filter for requests where paragraphs were used
profanity_filterbooleanOptional
Filter for requests where profanity filter was used
punctuatebooleanOptional
Filter for requests where punctuate was used
redactbooleanOptional
Filter for requests where redact was used
replacebooleanOptional
Filter for requests where replace was used
sample_ratebooleanOptional
Filter for requests where sample rate was used
searchbooleanOptional
Filter for requests where search was used
sentimentbooleanOptional
Filter for requests where sentiment was used
smart_formatbooleanOptional
Filter for requests where smart format was used
summarizebooleanOptional
Filter for requests where summarize was used
tagstringOptional
Filter for requests where a specific tag was used
topicsbooleanOptional
Filter for requests where topics was used
utt_splitbooleanOptional
Filter for requests where utt split was used
utterancesbooleanOptional
Filter for requests where utterances was used
versionbooleanOptional
Filter for requests where version was used

Response

Usage Summary
startstring or nullformat: "date"
endstring or nullformat: "date"
resolutionobject or null

Errors