Get Project Usage Breakdown

GET

/v1/projects/:project_id/usage/breakdown

1 import requests
2 
3 url = "https://api.deepgram.com/v1/projects/project_id/usage/breakdown"
4 
5 querystring = {"accessor":"12345678-1234-1234-1234-123456789012","alternatives":"true","callback_method":"true","callback":"true","channels":"true","custom_intent_mode":"true","custom_intent":"true","custom_topic_mode":"true","custom_topic":"true","deployment":"hosted","detect_entities":"true","detect_language":"true","diarize":"true","dictation":"true","encoding":"true","endpoint":"listen","extra":"true","filler_words":"true","intents":"true","keyterm":"true","keywords":"true","language":"true","measurements":"true","method":"async","model":"6f548761-c9c0-429a-9315-11a1d28499c8","multichannel":"true","numerals":"true","paragraphs":"true","profanity_filter":"true","punctuate":"true","redact":"true","replace":"true","search":"true","sentiment":"true","smart_format":"true","summarize":"true","tag":"tag1","topics":"true","utt_split":"true","utterances":"true","version":"true"}
6 
7 headers = {"Authorization": "<apiKey>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

Try it

200Retrieved

1 {
2   "start": "2025-01-16",
3   "end": "2025-01-23",
4   "resolution": {
5     "units": "day",
6     "amount": 1
7   },
8   "results": [
9     {
10       "hours": 1619.7242069444444,
11       "total_hours": 1621.7395791666668,
12       "agent_hours": 41.33564388888889,
13       "tokens_in": 0,
14       "tokens_out": 0,
15       "tts_characters": 9158866,
16       "requests": 373381,
17       "grouping": {
18         "start": "2025-01-16",
19         "end": "2025-01-16",
20         "accessor": "123456789012345678901234",
21         "endpoint": "listen",
22         "feature_set": "punctuate",
23         "models": "Nova-2",
24         "method": "async",
25         "tags": "tag1",
26         "deployment": "self-hosted"
27       }
28     }
29   ]
30 }

Retrieves the usage breakdown for a specific project, with various filter options by API feature or by groupings. Setting a feature (e.g. diarize) to true includes requests that used that feature, while false excludes requests that used it. Multiple true filters are combined with OR logic, while false filters use AND logic.

Authentication

Authorizationstring

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

Path Parameters

project_idstringRequired

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

groupingenumOptional

Common usage grouping parameters

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 breakdown response

startstringformat: "date"

Start date of the usage period

endstringformat: "date"

End date of the usage period

resolutionobject

resultslist of objects

Movatterモバイル変換

Get Project Usage Breakdown

Authentication

Path Parameters

Query Parameters

Response

Errors

1	import requests
2
3	url = "https://api.deepgram.com/v1/projects/project_id/usage/breakdown"
4
5	querystring = {"accessor":"12345678-1234-1234-1234-123456789012","alternatives":"true","callback_method":"true","callback":"true","channels":"true","custom_intent_mode":"true","custom_intent":"true","custom_topic_mode":"true","custom_topic":"true","deployment":"hosted","detect_entities":"true","detect_language":"true","diarize":"true","dictation":"true","encoding":"true","endpoint":"listen","extra":"true","filler_words":"true","intents":"true","keyterm":"true","keywords":"true","language":"true","measurements":"true","method":"async","model":"6f548761-c9c0-429a-9315-11a1d28499c8","multichannel":"true","numerals":"true","paragraphs":"true","profanity_filter":"true","punctuate":"true","redact":"true","replace":"true","search":"true","sentiment":"true","smart_format":"true","summarize":"true","tag":"tag1","topics":"true","utt_split":"true","utterances":"true","version":"true"}
6
7	headers = {"Authorization": "<apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"start": "2025-01-16",
3	"end": "2025-01-23",
4	"resolution": {
5	"units": "day",
6	"amount": 1
7	},
8	"results": [
9	{
10	"hours": 1619.7242069444444,
11	"total_hours": 1621.7395791666668,
12	"agent_hours": 41.33564388888889,
13	"tokens_in": 0,
14	"tokens_out": 0,
15	"tts_characters": 9158866,
16	"requests": 373381,
17	"grouping": {
18	"start": "2025-01-16",
19	"end": "2025-01-16",
20	"accessor": "123456789012345678901234",
21	"endpoint": "listen",
22	"feature_set": "punctuate",
23	"models": "Nova-2",
24	"method": "async",
25	"tags": "tag1",
26	"deployment": "self-hosted"
27	}
28	}
29	]
30	}