Package com.datadog.api.client.v2.api

Class DashboardsApi

java.lang.Object

com.datadog.api.client.v2.api.DashboardsApi

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class DashboardsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DashboardsApi.ListDashboardsUsageOptionalParameters	Manage optional parameters to listDashboardsUsage.

Constructor Summary

Constructors

Constructor	Description
DashboardsApi()
DashboardsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
DashboardUsageResponse	getDashboardUsage(String dashboardId)	Get usage stats for a dashboard.
CompletableFuture<DashboardUsageResponse>	getDashboardUsageAsync(String dashboardId)	Get usage stats for a dashboard.
ApiResponse<DashboardUsageResponse>	getDashboardUsageWithHttpInfo(String dashboardId)	Get usage statistics for a single dashboard.
CompletableFuture<ApiResponse<DashboardUsageResponse>>	getDashboardUsageWithHttpInfoAsync(String dashboardId)	Get usage stats for a dashboard.
ListDashboardsUsageResponse	listDashboardsUsage()	Get usage stats for all dashboards.
ListDashboardsUsageResponse	listDashboardsUsage(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)	Get usage stats for all dashboards.
CompletableFuture<ListDashboardsUsageResponse>	listDashboardsUsageAsync()	Get usage stats for all dashboards.
CompletableFuture<ListDashboardsUsageResponse>	listDashboardsUsageAsync(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)	Get usage stats for all dashboards.
ApiResponse<ListDashboardsUsageResponse>	listDashboardsUsageWithHttpInfo(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)	Get paginated usage statistics for every dashboard in the caller's organization.
CompletableFuture<ApiResponse<ListDashboardsUsageResponse>>	listDashboardsUsageWithHttpInfoAsync(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)	Get usage stats for all dashboards.
PaginationIterable<DashboardUsage>	listDashboardsUsageWithPagination()	Get usage stats for all dashboards.
PaginationIterable<DashboardUsage>	listDashboardsUsageWithPagination(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)	Get usage stats for all dashboards.
void	setApiClient(ApiClient apiClient)	Set the API client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DashboardsApi

public DashboardsApi()

DashboardsApi

public DashboardsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

getDashboardUsage

public DashboardUsageResponse getDashboardUsage(String dashboardId)
                                         throws ApiException

Get usage stats for a dashboard.

See getDashboardUsageWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

DashboardUsageResponse

Throws:

ApiException - if fails to make API call

getDashboardUsageAsync

public CompletableFuture<DashboardUsageResponse> getDashboardUsageAsync(String dashboardId)

Get usage stats for a dashboard.

See getDashboardUsageWithHttpInfoAsync(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<DashboardUsageResponse>

getDashboardUsageWithHttpInfo

public ApiResponse<DashboardUsageResponse> getDashboardUsageWithHttpInfo(String dashboardId)
                                                                  throws ApiException

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. View counts are refreshed once per day and only reflect views recorded starting January 2025; views prior to that date are not included.

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

ApiResponse<DashboardUsageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getDashboardUsageWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardUsageResponse>> getDashboardUsageWithHttpInfoAsync(String dashboardId)

Get usage stats for a dashboard.

See getDashboardUsageWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<ApiResponse<DashboardUsageResponse>>

listDashboardsUsage

public ListDashboardsUsageResponse listDashboardsUsage()
                                                throws ApiException

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfo(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Returns:

ListDashboardsUsageResponse

Throws:

ApiException - if fails to make API call

listDashboardsUsageAsync

public CompletableFuture<ListDashboardsUsageResponse> listDashboardsUsageAsync()

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfoAsync(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Returns:

CompletableFuture<ListDashboardsUsageResponse>

listDashboardsUsage

public ListDashboardsUsageResponse listDashboardsUsage(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)
                                                throws ApiException

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfo(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListDashboardsUsageResponse

Throws:

ApiException - if fails to make API call

listDashboardsUsageAsync

public CompletableFuture<ListDashboardsUsageResponse> listDashboardsUsageAsync(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfoAsync(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListDashboardsUsageResponse>

listDashboardsUsageWithPagination

public PaginationIterable<DashboardUsage> listDashboardsUsageWithPagination()

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfo(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Returns:

PaginationIterable<DashboardUsage>

listDashboardsUsageWithPagination

public PaginationIterable<DashboardUsage> listDashboardsUsageWithPagination(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfo(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Returns:

ListDashboardsUsageResponse

listDashboardsUsageWithHttpInfo

public ApiResponse<ListDashboardsUsageResponse> listDashboardsUsageWithHttpInfo(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)
                                                                         throws ApiException

Get paginated usage statistics for every dashboard in the caller's organization. Use page[limit] and page[offset] to walk the result set. Use filter[edited_before] or filter[viewed_before] to narrow results by edit or view date. View-count fields depend on Real User Monitoring (RUM) and are null or 0 in orgs without RUM. View counts are refreshed once per day and only reflect views recorded starting January 2025; views prior to that date are not included.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListDashboardsUsageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

listDashboardsUsageWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListDashboardsUsageResponse>> listDashboardsUsageWithHttpInfoAsync(DashboardsApi.ListDashboardsUsageOptionalParameters parameters)

Get usage stats for all dashboards.

See listDashboardsUsageWithHttpInfo(com.datadog.api.client.v2.api.DashboardsApi.ListDashboardsUsageOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListDashboardsUsageResponse>>