Logs & Usage Data

Learn how to use Deepgram’s Log and Usage features.

You can obtain up to 90 days of log usage data from Deepgram. If you need log usage data for a longer period of time you can use our Usage API to programmatically fetch usage data on an interval and store it for retrieval as needed.

Using Console Logs & Usage

Within the Deepgram Console you can view your API usage and API log activity of all your requests.

To view your Summarized Usage

Not limited to 90 days.

  1. Login to the Deepgram Console
  2. Click on the Usage Tab in the left navigation panel.
  3. On the Overview Tab, select your filter options.
  4. View the results.

To view your Logs

Limited to 90 days.

  1. Login to the Deepgram Console
  2. Click on the Usage Tab in the left navigation panel.
  3. On the Logs Tab, select your filter options.
  4. View the results.

Obtaining Usage via the API

You can use the Deepgram API to programmatically fetch usage data. Please refer to our API documentation for more details.

This also enables exporting and reporting on your usage, which can be imported into other tools of your choosing, such as Tableau, Grafana, or Datadog.

Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key.

Get All Requests

Replace YOUR_PROJECT_IDwith your Deepgram project id.

cURL
$curl --request GET \
>     --url 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/requests?start=2023-10-01&end=2023-10-05&status=succeeded' \
>     --header 'Authorization: Token YOUR_DEEPGRAM_API_KEY' \
>     --header 'accept: application/json'

A response will be returned as such:

JSON
1{
2    "page": 0,
3    "limit": 1,
4    "requests": [
5        {
6            "request_id": "a758d58d-e3ec-xxx",
7            "created": "2023-10-05T22:49:03.509654Z",
8            "path": "/v1/listen?-xxx",
9            "api_key_id": "f54158f4-xxx-xxx",
10            "response": null,
11            "callback": null
12        }
13    ]
14}

Summarize Usage

Summarized usage data is not limited to 90 days.

Replace YOUR_PROJECT_IDwith your Deepgram project id.

cURL
$curl --request GET \
>     --url 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/usage?start=2023-10-01&end=2023-10-05' \
>     --header 'Authorization: Token YOUR_DEEPGRAM_API_KEY' \
>     --header 'accept: application/json'

A response will be returned:

JSON
1{
2    "start": "2023-10-01",
3    "end": "2023-10-05",
4    "resolution": {
5        "units": "day",
6        "amount": 1
7    },
8    "results": [
9        {
10            "start": "2023-10-01",
11            "end": "2023-10-01",
12            "hours": 865.7331186111111,
13            "total_hours": 867.6975186111111,
14            "requests": 54105
15        },
16        {
17            "start": "2023-10-02",
18            "end": "2023-10-02",
19            "hours": 1188.9926763888889,
20            "total_hours": 1191.5563763888888,
21            "requests": 56081
22        },
23        {
24            "start": "2023-10-03",
25            "end": "2023-10-03",
26            "hours": 1473.9747994444444,
27            "total_hours": 1477.5771794444445,
28            "requests": 56456
29        },
30        {
31            "start": "2023-10-04",
32            "end": "2023-10-04",
33            "hours": 999.2419933333333,
34            "total_hours": 1001.2063933333334,
35            "requests": 54548
36        },
37        {
38            "start": "2023-10-05",
39            "end": "2023-10-05",
40            "hours": 11447.164485833333,
41            "total_hours": 11449.0443075,
42            "requests": 196209
43        }
44    ]
45}

Understanding Console Usage Log States

Within the Deepgram Console you can view usage request logs and you may see requests in different states. Below is an explanation of what those states mean and a recommended resolution.

StateMeaningRecommended Resolution
PendingData on the response hasn’t been recorded yet.Give the request time to process.
UnknownWe haven’t confirmed the resolution of this request yet.Wait for the request to transition to Lost, Error, or Success.
LostThe resolution for this request was never logged. You won’t be charged for this request.Contact Support for assistance.
ErrorThis request had an error.Retry the request.

What’s Next

Built with