@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
90 lines (89 loc) • 2.87 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { DashboardUsageUser } from "./DashboardUsageUser";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* 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.
*/
export declare class DashboardUsageAttributes {
/**
* A user referenced from a dashboard usage record (author or viewer).
*/
"author"?: DashboardUsageUser;
/**
* When the dashboard was created.
*/
"createdAt"?: Date;
/**
* The dashboard quality score, or `null` when no score is available.
*/
"dashboardQualityScore"?: number;
/**
* When the dashboard was most recently edited.
*/
"editedAt"?: Date;
/**
* The Datadog organization that owns the dashboard.
*/
"orgId": number;
/**
* Teams the dashboard is tagged with.
*/
"teams"?: Array<string>;
/**
* The dashboard title.
*/
"title"?: string;
/**
* Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); `0` in orgs without RUM.
*/
"totalViews"?: number;
/**
* 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.
*/
"totalViewsByType"?: {
[key: string]: number;
};
/**
* When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; `null` in orgs without RUM.
*/
"viewedAt"?: Date;
/**
* A user referenced from a dashboard usage record (author or viewer).
*/
"viewer"?: DashboardUsageUser;
/**
* The total number of widgets on the dashboard.
*/
"widgetCount"?: number;
/**
* Widget counts keyed by widget type. The map includes group widgets and widgets without requests.
*/
"widgetCountByType"?: {
[key: string]: number;
};
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}