Get usage stats for a dashboard

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.ap2.datadoghq.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.datadoghq.eu/api/v2/dashboards/{dashboard_id}/usagehttps://api.ddog-gov.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.us2.ddog-gov.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.datadoghq.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.us3.datadoghq.com/api/v2/dashboards/{dashboard_id}/usagehttps://api.us5.datadoghq.com/api/v2/dashboards/{dashboard_id}/usage

Overview

Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are null or 0 in orgs without RUM. This endpoint requires the dashboards_read permission.

OAuth apps require the dashboards_read authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

dashboard_id [required]

string

The ID of the dashboard.

Response

OK

Response containing usage statistics for a single dashboard.

Expand All

Field

Type

Description

data [required]

object

A single dashboard usage record.

attributes [required]

object

Usage statistics for a dashboard. The viewer field and all view-count fields (total_views, viewed_at, total_views_by_type) are populated only when Real User Monitoring (RUM) is active for the org.

author

object

A user referenced from a dashboard usage record (author or viewer).

handle

string

Datadog handle (login) of the user.

id

string

The user ID.

is_disabled

boolean

Whether the user account is disabled.

name

string

Display name of the user.

created_at

date-time

When the dashboard was created.

dashboard_quality_score

double

The dashboard quality score, or null when no score is available.

edited_at

date-time

When the dashboard was most recently edited.

org_id [required]

int64

The Datadog organization that owns the dashboard.

teams

[string]

Teams the dashboard is tagged with.

title

string

The dashboard title.

total_views

int64

Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); 0 in orgs without RUM.

total_views_by_type

object

View counts keyed by view type (in_app, embed, public, shared, api, unknown). Counts only views captured by Real User Monitoring (RUM); empty in orgs without RUM.

<any-key>

int64

View count for that view type.

viewed_at

date-time

When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; null in orgs without RUM.

viewer

object

A user referenced from a dashboard usage record (author or viewer).

handle

string

Datadog handle (login) of the user.

id

string

The user ID.

is_disabled

boolean

Whether the user account is disabled.

name

string

Display name of the user.

widget_count

int64

The total number of widgets on the dashboard.

widget_count_by_type

object

Widget counts keyed by widget type. The map includes group widgets and widgets without requests.

<any-key>

int64

Widget count for that widget type.

id [required]

string

The dashboard ID.

type [required]

enum

The type of the resource. Always dashboards-usages. Allowed enum values: dashboards-usages

default: dashboards-usages

{
  "data": {
    "attributes": {
      "author": {
        "handle": "jane.doe@example.com",
        "id": "00000000-0000-0000-0000-000000000000",
        "is_disabled": false,
        "name": "Jane Doe"
      },
      "created_at": "2026-01-15T09:30:00.000Z",
      "dashboard_quality_score": 0.85,
      "edited_at": "2026-04-20T11:05:00.000Z",
      "org_id": 100,
      "teams": [],
      "title": "My production overview",
      "total_views": 42,
      "total_views_by_type": {
        "<any-key>": "integer"
      },
      "viewed_at": "2026-05-01T14:22:10.000Z",
      "viewer": {
        "handle": "jane.doe@example.com",
        "id": "00000000-0000-0000-0000-000000000000",
        "is_disabled": false,
        "name": "Jane Doe"
      },
      "widget_count": 12,
      "widget_count_by_type": {
        "<any-key>": "integer"
      }
    },
    "id": "q5j-nti-fv6",
    "type": "dashboards-usages"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export dashboard_id="q5j-nti-fv6"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboards/${dashboard_id}/usage" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"