Get Project Usage Breakdown

GET/v1/projects/{project_id}/usage/breakdownGet Project Usage Breakdown

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.

Parameters

project_idstringpathrequired

The unique identifier of the project

startstring · datequery

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

endstring · datequery

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

groupingstringquery

Common usage grouping parameters

one of "accessor", "endpoint", "feature_set", "models", "method", "tags", "deployment"

accessorstringquery

Filter for requests where a specific accessor was used

alternativesbooleanquery

Filter for requests where alternatives were used

callback_methodbooleanquery

Filter for requests where callback method was used

callbackbooleanquery

Filter for requests where callback was used

channelsbooleanquery

Filter for requests where channels were used

custom_intent_modebooleanquery

Filter for requests where custom intent mode was used

custom_intentbooleanquery

Filter for requests where custom intent was used

custom_topic_modebooleanquery

Filter for requests where custom topic mode was used

custom_topicbooleanquery

Filter for requests where custom topic was used

deploymentstringquery

Filter for requests where a specific deployment was used

one of "hosted", "beta", "self-hosted"

detect_entitiesbooleanquery

Filter for requests where detect entities was used

detect_languagebooleanquery

Filter for requests where detect language was used

diarizebooleanquery

Filter for requests where diarize was used

dictationbooleanquery

Filter for requests where dictation was used

encodingbooleanquery

Filter for requests where encoding was used

endpointstringquery

Filter for requests where a specific endpoint was used

one of "listen", "read", "speak", "agent"

extrabooleanquery

Filter for requests where extra was used

filler_wordsbooleanquery

Filter for requests where filler words was used

intentsbooleanquery

Filter for requests where intents was used

keytermbooleanquery

Filter for requests where keyterm was used

keywordsbooleanquery

Filter for requests where keywords was used

languagebooleanquery

Filter for requests where language was used

measurementsbooleanquery

Filter for requests where measurements were used

methodstringquery

Filter for requests where a specific method was used

one of "sync", "async", "streaming"

modelstringquery

Filter for requests where a specific model uuid was used

multichannelbooleanquery

Filter for requests where multichannel was used

numeralsbooleanquery

Filter for requests where numerals were used

paragraphsbooleanquery

Filter for requests where paragraphs were used

profanity_filterbooleanquery

Filter for requests where profanity filter was used

punctuatebooleanquery

Filter for requests where punctuate was used

redactbooleanquery

Filter for requests where redact was used

replacebooleanquery

Filter for requests where replace was used

sample_ratebooleanquery

Filter for requests where sample rate was used

searchbooleanquery

Filter for requests where search was used

sentimentbooleanquery

Filter for requests where sentiment was used

smart_formatbooleanquery

Filter for requests where smart format was used

summarizebooleanquery

Filter for requests where summarize was used

tagstringquery

Filter for requests where a specific tag was used

topicsbooleanquery

Filter for requests where topics was used

utt_splitbooleanquery

Filter for requests where utt split was used

utterancesbooleanquery

Filter for requests where utterances was used

versionbooleanquery

Filter for requests where version was used

Responses

objectUsageBreakdownV1Response

UsageBreakdownV1Response

endstring · daterequired

End date of the usage period

resolutionobjectrequired

Show child attributes

amountnumber · doublerequired

Amount of units

unitsstringrequired

Time unit for the resolution

resultsarray of objectrequired

Show child attributes

Show array items

agent_hoursstringrequired

Agent hours used

groupingobjectrequired

Show child attributes

accessornull | string

Optional accessor identifier

deploymentnull | string

Optional deployment identifier

endstring · date

End date for this group

endpointnull | string

Optional endpoint identifier

feature_setnull | string

Optional feature set identifier

methodnull | string

Optional method identifier

modelsarray of string

Show child attributes

startstring · date

Start date for this group

tagsarray of string

Optional list of tags, null unless grouped by tags.

Show child attributes

hoursstringrequired

Audio hours processed

requestsnumber · doublerequired

Number of requests

tokens_innumber · doublerequired

Number of input tokens

tokens_outnumber · doublerequired

Number of output tokens

total_hoursstringrequired

Total hours including all processing

tts_charactersnumber · doublerequired

Number of text-to-speech characters processed

startstring · daterequired

Start date of the usage period

Example response

{
  "end": "2026-06-09",
  "resolution": {
    "amount": 0,
    "units": "string"
  },
  "results": [
    {
      "agent_hours": "string",
      "grouping": {
        "accessor": "string",
        "deployment": "string",
        "end": "2026-06-09",
        "endpoint": "string",
        "feature_set": "string",
        "method": "string",
        "models": [
          "string"
        ],
        "start": "2026-06-09",
        "tags": [
          "string"
        ]
      },
      "hours": "string",
      "requests": 0,
      "tokens_in": 0,
      "tokens_out": 0,
      "total_hours": "string",
      "tts_characters": 0
    }
  ],
  "start": "2026-06-09"
}

valueErrorResponse

ErrorResponse

oneOf · 3 options

Option 1stringErrorResponseTextError

ErrorResponseTextError

Option 2objectErrorResponseLegacyError

ErrorResponseLegacyError

err_codestring

The error code

err_msgstring

The error message

request_idstring

The request ID

Option 3objectErrorResponseModernError

ErrorResponseModernError

categorystring

The category of the error

detailsstring

A description of the error

messagestring

A message about the error

request_idstring

The unique identifier of the request

Example response

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

startquery parameter

endquery parameter

groupingquery parameter

accessorquery parameter

alternativesquery parameter

callback_methodquery parameter

callbackquery parameter

channelsquery parameter

custom_intent_modequery parameter

custom_intentquery parameter

custom_topic_modequery parameter

custom_topicquery parameter

deploymentquery parameter

detect_entitiesquery parameter

detect_languagequery parameter

diarizequery parameter

dictationquery parameter

encodingquery parameter

endpointquery parameter

extraquery parameter

filler_wordsquery parameter

intentsquery parameter

keytermquery parameter

keywordsquery parameter

languagequery parameter

measurementsquery parameter

methodquery parameter

modelquery parameter

multichannelquery parameter

numeralsquery parameter

paragraphsquery parameter

profanity_filterquery parameter

punctuatequery parameter

redactquery parameter

replacequery parameter

sample_ratequery parameter

searchquery parameter

sentimentquery parameter

smart_formatquery parameter

summarizequery parameter

tagquery parameter

topicsquery parameter

utt_splitquery parameter

utterancesquery parameter

versionquery parameter

curl -X GET 'https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://agent.deepgram.com/v1/projects/string/usage/breakdown?accessor=string&alternatives=true&callback=true&callback_method=true&channels=true&custom_intent=true&custom_intent_mode=true&custom_topic=true&custom_topic_mode=true&deployment=beta&detect_entities=true&detect_language=true&diarize=true&dictation=true&encoding=true&end=2026-06-09&endpoint=agent&extra=true&filler_words=true&grouping=accessor&intents=true&keyterm=true&keywords=true&language=true&measurements=true&method=async&model=string&multichannel=true&numerals=true&paragraphs=true&profanity_filter=true&punctuate=true&redact=true&replace=true&sample_rate=true&search=true&sentiment=true&smart_format=true&start=2026-06-09&summarize=true&tag=string&topics=true&utt_split=true&utterances=true&version=true");
using var response = await client.SendAsync(request);

{
  "end": "2026-06-09",
  "resolution": {
    "amount": 0,
    "units": "string"
  },
  "results": [
    {
      "agent_hours": "string",
      "grouping": {
        "accessor": "string",
        "deployment": "string",
        "end": "2026-06-09",
        "endpoint": "string",
        "feature_set": "string",
        "method": "string",
        "models": [
          "string"
        ],
        "start": "2026-06-09",
        "tags": [
          "string"
        ]
      },
      "hours": "string",
      "requests": 0,
      "tokens_in": 0,
      "tokens_out": 0,
      "total_hours": "string",
      "tts_characters": 0
    }
  ],
  "start": "2026-06-09"
}

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}