Skip to content

Commit 84f17de

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Product Analytics widget definitions (#3907)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 3a698ef commit 84f17de

File tree

65 files changed

+4351
-168
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+4351
-168
lines changed

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 1193 additions & 165 deletions
Large diffs are not rendered by default.

‎packages/datadog-api-client-v1/index.ts‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,8 @@ export { BarChartWidgetScaling } from "./models/BarChartWidgetScaling";
387387
export { BarChartWidgetStacked } from "./models/BarChartWidgetStacked";
388388
export { BarChartWidgetStackedType } from "./models/BarChartWidgetStackedType";
389389
export { BarChartWidgetStyle } from "./models/BarChartWidgetStyle";
390+
export { CalendarInterval } from "./models/CalendarInterval";
391+
export { CalendarIntervalType } from "./models/CalendarIntervalType";
390392
export { CancelDowntimesByScopeRequest } from "./models/CancelDowntimesByScopeRequest";
391393
export { CanceledDowntimesIds } from "./models/CanceledDowntimesIds";
392394
export { ChangeWidgetDefinition } from "./models/ChangeWidgetDefinition";
@@ -398,6 +400,8 @@ export { CheckCanDeleteSLOResponse } from "./models/CheckCanDeleteSLOResponse";
398400
export { CheckCanDeleteSLOResponseData } from "./models/CheckCanDeleteSLOResponseData";
399401
export { CheckStatusWidgetDefinition } from "./models/CheckStatusWidgetDefinition";
400402
export { CheckStatusWidgetDefinitionType } from "./models/CheckStatusWidgetDefinitionType";
403+
export { CohortWidgetDefinition } from "./models/CohortWidgetDefinition";
404+
export { CohortWidgetDefinitionType } from "./models/CohortWidgetDefinitionType";
401405
export { ContentEncoding } from "./models/ContentEncoding";
402406
export { Creator } from "./models/Creator";
403407
export { Dashboard } from "./models/Dashboard";
@@ -479,16 +483,25 @@ export { FormulaAndFunctionMetricQueryDefinition } from "./models/FormulaAndFunc
479483
export { FormulaAndFunctionMetricSemanticMode } from "./models/FormulaAndFunctionMetricSemanticMode";
480484
export { FormulaAndFunctionProcessQueryDataSource } from "./models/FormulaAndFunctionProcessQueryDataSource";
481485
export { FormulaAndFunctionProcessQueryDefinition } from "./models/FormulaAndFunctionProcessQueryDefinition";
486+
export { FormulaAndFunctionProductAnalyticsExtendedDataSource } from "./models/FormulaAndFunctionProductAnalyticsExtendedDataSource";
487+
export { FormulaAndFunctionProductAnalyticsExtendedQueryDefinition } from "./models/FormulaAndFunctionProductAnalyticsExtendedQueryDefinition";
488+
export { FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems } from "./models/FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems";
482489
export { FormulaAndFunctionQueryDefinition } from "./models/FormulaAndFunctionQueryDefinition";
483490
export { FormulaAndFunctionResponseFormat } from "./models/FormulaAndFunctionResponseFormat";
491+
export { FormulaAndFunctionRetentionQueryDefinition } from "./models/FormulaAndFunctionRetentionQueryDefinition";
484492
export { FormulaAndFunctionSLODataSource } from "./models/FormulaAndFunctionSLODataSource";
485493
export { FormulaAndFunctionSLOGroupMode } from "./models/FormulaAndFunctionSLOGroupMode";
486494
export { FormulaAndFunctionSLOMeasure } from "./models/FormulaAndFunctionSLOMeasure";
487495
export { FormulaAndFunctionSLOQueryDefinition } from "./models/FormulaAndFunctionSLOQueryDefinition";
488496
export { FormulaAndFunctionSLOQueryType } from "./models/FormulaAndFunctionSLOQueryType";
497+
export { FormulaAndFunctionUserJourneyQueryDefinition } from "./models/FormulaAndFunctionUserJourneyQueryDefinition";
489498
export { FormulaType } from "./models/FormulaType";
490499
export { FreeTextWidgetDefinition } from "./models/FreeTextWidgetDefinition";
491500
export { FreeTextWidgetDefinitionType } from "./models/FreeTextWidgetDefinitionType";
501+
export { FunnelComparisonCustomTimeframe } from "./models/FunnelComparisonCustomTimeframe";
502+
export { FunnelComparisonDuration } from "./models/FunnelComparisonDuration";
503+
export { FunnelComparisonDurationType } from "./models/FunnelComparisonDurationType";
504+
export { FunnelGroupedDisplay } from "./models/FunnelGroupedDisplay";
492505
export { FunnelQuery } from "./models/FunnelQuery";
493506
export { FunnelRequestType } from "./models/FunnelRequestType";
494507
export { FunnelSource } from "./models/FunnelSource";
@@ -812,13 +825,50 @@ export { ProductAnalyticsAudienceFilters } from "./models/ProductAnalyticsAudien
812825
export { ProductAnalyticsAudienceOccurrenceFilter } from "./models/ProductAnalyticsAudienceOccurrenceFilter";
813826
export { ProductAnalyticsAudienceSegmentSubquery } from "./models/ProductAnalyticsAudienceSegmentSubquery";
814827
export { ProductAnalyticsAudienceUserSubquery } from "./models/ProductAnalyticsAudienceUserSubquery";
828+
export { ProductAnalyticsExtendedCompute } from "./models/ProductAnalyticsExtendedCompute";
829+
export { ProductAnalyticsExtendedGroupBy } from "./models/ProductAnalyticsExtendedGroupBy";
830+
export { ProductAnalyticsFunnelCompute } from "./models/ProductAnalyticsFunnelCompute";
831+
export { ProductAnalyticsFunnelComputeAggregation } from "./models/ProductAnalyticsFunnelComputeAggregation";
832+
export { ProductAnalyticsFunnelComputeMetric } from "./models/ProductAnalyticsFunnelComputeMetric";
833+
export { ProductAnalyticsFunnelDataSource } from "./models/ProductAnalyticsFunnelDataSource";
834+
export { ProductAnalyticsFunnelGroupBy } from "./models/ProductAnalyticsFunnelGroupBy";
835+
export { ProductAnalyticsFunnelGroupBySort } from "./models/ProductAnalyticsFunnelGroupBySort";
836+
export { ProductAnalyticsFunnelQuery } from "./models/ProductAnalyticsFunnelQuery";
837+
export { ProductAnalyticsFunnelRequest } from "./models/ProductAnalyticsFunnelRequest";
838+
export { ProductAnalyticsFunnelRequestType } from "./models/ProductAnalyticsFunnelRequestType";
839+
export { ProductAnalyticsFunnelWidgetDefinition } from "./models/ProductAnalyticsFunnelWidgetDefinition";
815840
export { QuerySortOrder } from "./models/QuerySortOrder";
816841
export { QueryValueWidgetDefinition } from "./models/QueryValueWidgetDefinition";
817842
export { QueryValueWidgetDefinitionType } from "./models/QueryValueWidgetDefinitionType";
818843
export { QueryValueWidgetRequest } from "./models/QueryValueWidgetRequest";
819844
export { ReferenceTableLogsLookupProcessor } from "./models/ReferenceTableLogsLookupProcessor";
820845
export { ResourceProviderConfig } from "./models/ResourceProviderConfig";
821846
export { ResponseMetaAttributes } from "./models/ResponseMetaAttributes";
847+
export { RetentionCohortCriteria } from "./models/RetentionCohortCriteria";
848+
export { RetentionCohortCriteriaTimeInterval } from "./models/RetentionCohortCriteriaTimeInterval";
849+
export { RetentionCohortCriteriaTimeIntervalType } from "./models/RetentionCohortCriteriaTimeIntervalType";
850+
export { RetentionCompute } from "./models/RetentionCompute";
851+
export { RetentionComputeMetric } from "./models/RetentionComputeMetric";
852+
export { RetentionCurveRequestType } from "./models/RetentionCurveRequestType";
853+
export { RetentionCurveStyle } from "./models/RetentionCurveStyle";
854+
export { RetentionCurveWidgetDefinition } from "./models/RetentionCurveWidgetDefinition";
855+
export { RetentionCurveWidgetDefinitionType } from "./models/RetentionCurveWidgetDefinitionType";
856+
export { RetentionCurveWidgetRequest } from "./models/RetentionCurveWidgetRequest";
857+
export { RetentionDataSource } from "./models/RetentionDataSource";
858+
export { RetentionEntity } from "./models/RetentionEntity";
859+
export { RetentionFilters } from "./models/RetentionFilters";
860+
export { RetentionGridRequest } from "./models/RetentionGridRequest";
861+
export { RetentionGridRequestType } from "./models/RetentionGridRequestType";
862+
export { RetentionGroupBy } from "./models/RetentionGroupBy";
863+
export { RetentionGroupBySort } from "./models/RetentionGroupBySort";
864+
export { RetentionGroupByTarget } from "./models/RetentionGroupByTarget";
865+
export { RetentionQuery } from "./models/RetentionQuery";
866+
export { RetentionReturnCondition } from "./models/RetentionReturnCondition";
867+
export { RetentionReturnCriteria } from "./models/RetentionReturnCriteria";
868+
export { RetentionReturnCriteriaTimeInterval } from "./models/RetentionReturnCriteriaTimeInterval";
869+
export { RetentionReturnCriteriaTimeIntervalType } from "./models/RetentionReturnCriteriaTimeIntervalType";
870+
export { RetentionReturnCriteriaTimeIntervalUnit } from "./models/RetentionReturnCriteriaTimeIntervalUnit";
871+
export { RetentionSearch } from "./models/RetentionSearch";
822872
export { RunWorkflowWidgetDefinition } from "./models/RunWorkflowWidgetDefinition";
823873
export { RunWorkflowWidgetDefinitionType } from "./models/RunWorkflowWidgetDefinitionType";
824874
export { RunWorkflowWidgetInput } from "./models/RunWorkflowWidgetInput";
@@ -1280,6 +1330,14 @@ export { UsageTopAvgMetricsPagination } from "./models/UsageTopAvgMetricsPaginat
12801330
export { UsageTopAvgMetricsResponse } from "./models/UsageTopAvgMetricsResponse";
12811331
export { User } from "./models/User";
12821332
export { UserDisableResponse } from "./models/UserDisableResponse";
1333+
export { UserJourneyFormulaCompute } from "./models/UserJourneyFormulaCompute";
1334+
export { UserJourneyFormulaComputeMetric } from "./models/UserJourneyFormulaComputeMetric";
1335+
export { UserJourneyFormulaGroupBy } from "./models/UserJourneyFormulaGroupBy";
1336+
export { UserJourneyJoinKeys } from "./models/UserJourneyJoinKeys";
1337+
export { UserJourneySearch } from "./models/UserJourneySearch";
1338+
export { UserJourneySearchFilters } from "./models/UserJourneySearchFilters";
1339+
export { UserJourneySearchGraphFilter } from "./models/UserJourneySearchGraphFilter";
1340+
export { UserJourneySearchTarget } from "./models/UserJourneySearchTarget";
12831341
export { UserListResponse } from "./models/UserListResponse";
12841342
export { UserResponse } from "./models/UserResponse";
12851343
export { ViewingPreferences } from "./models/ViewingPreferences";

‎packages/datadog-api-client-v1/models/CalendarInterval.ts‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { CalendarIntervalType } from "./CalendarIntervalType";
7+
8+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
9+
10+
/**
11+
* Calendar interval definition.
12+
*/
13+
export class CalendarInterval {
14+
/**
15+
* Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`).
16+
*/
17+
"alignment"?: string;
18+
/**
19+
* Quantity of the interval.
20+
*/
21+
"quantity"?: number;
22+
/**
23+
* Timezone for the interval.
24+
*/
25+
"timezone"?: string;
26+
/**
27+
* Type of calendar interval.
28+
*/
29+
"type": CalendarIntervalType;
30+
31+
/**
32+
* @ignore
33+
*/
34+
"_unparsed"?: boolean;
35+
36+
/**
37+
* @ignore
38+
*/
39+
static readonly attributeTypeMap: AttributeTypeMap = {
40+
alignment: {
41+
baseName: "alignment",
42+
type: "string",
43+
},
44+
quantity: {
45+
baseName: "quantity",
46+
type: "number",
47+
format: "int64",
48+
},
49+
timezone: {
50+
baseName: "timezone",
51+
type: "string",
52+
},
53+
type: {
54+
baseName: "type",
55+
type: "CalendarIntervalType",
56+
required: true,
57+
},
58+
};
59+
60+
/**
61+
* @ignore
62+
*/
63+
static getAttributeTypeMap(): AttributeTypeMap {
64+
return CalendarInterval.attributeTypeMap;
65+
}
66+
67+
public constructor() {}
68+
}

‎packages/datadog-api-client-v1/models/CalendarIntervalType.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Type of calendar interval.
11+
*/
12+
13+
export type CalendarIntervalType =
14+
| typeof DAY
15+
| typeof WEEK
16+
| typeof MONTH
17+
| typeof YEAR
18+
| typeof QUARTER
19+
| typeof MINUTE
20+
| typeof HOUR
21+
| UnparsedObject;
22+
export const DAY = "day";
23+
export const WEEK = "week";
24+
export const MONTH = "month";
25+
export const YEAR = "year";
26+
export const QUARTER = "quarter";
27+
export const MINUTE = "minute";
28+
export const HOUR = "hour";

‎packages/datadog-api-client-v1/models/CohortWidgetDefinition.ts‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { CohortWidgetDefinitionType } from "./CohortWidgetDefinitionType";
7+
import { RetentionGridRequest } from "./RetentionGridRequest";
8+
import { WidgetTextAlign } from "./WidgetTextAlign";
9+
import { WidgetTime } from "./WidgetTime";
10+
11+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
12+
13+
/**
14+
* The cohort widget visualizes user retention over time.
15+
*/
16+
export class CohortWidgetDefinition {
17+
/**
18+
* The description of the widget.
19+
*/
20+
"description"?: string;
21+
/**
22+
* List of Cohort widget requests.
23+
*/
24+
"requests": Array<RetentionGridRequest>;
25+
/**
26+
* Time setting for the widget.
27+
*/
28+
"time"?: WidgetTime;
29+
/**
30+
* Title of your widget.
31+
*/
32+
"title"?: string;
33+
/**
34+
* How to align the text on the widget.
35+
*/
36+
"titleAlign"?: WidgetTextAlign;
37+
/**
38+
* Size of the title.
39+
*/
40+
"titleSize"?: string;
41+
/**
42+
* Type of the Cohort widget.
43+
*/
44+
"type": CohortWidgetDefinitionType;
45+
46+
/**
47+
* @ignore
48+
*/
49+
"_unparsed"?: boolean;
50+
51+
/**
52+
* @ignore
53+
*/
54+
static readonly attributeTypeMap: AttributeTypeMap = {
55+
description: {
56+
baseName: "description",
57+
type: "string",
58+
},
59+
requests: {
60+
baseName: "requests",
61+
type: "Array<RetentionGridRequest>",
62+
required: true,
63+
},
64+
time: {
65+
baseName: "time",
66+
type: "WidgetTime",
67+
},
68+
title: {
69+
baseName: "title",
70+
type: "string",
71+
},
72+
titleAlign: {
73+
baseName: "title_align",
74+
type: "WidgetTextAlign",
75+
},
76+
titleSize: {
77+
baseName: "title_size",
78+
type: "string",
79+
},
80+
type: {
81+
baseName: "type",
82+
type: "CohortWidgetDefinitionType",
83+
required: true,
84+
},
85+
};
86+
87+
/**
88+
* @ignore
89+
*/
90+
static getAttributeTypeMap(): AttributeTypeMap {
91+
return CohortWidgetDefinition.attributeTypeMap;
92+
}
93+
94+
public constructor() {}
95+
}

‎packages/datadog-api-client-v1/models/CohortWidgetDefinitionType.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Type of the Cohort widget.
11+
*/
12+
13+
export type CohortWidgetDefinitionType = typeof COHORT | UnparsedObject;
14+
export const COHORT = "cohort";

‎packages/datadog-api-client-v1/models/FormulaAndFunctionProductAnalyticsExtendedDataSource.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Data source for Product Analytics Extended queries.
11+
*/
12+
13+
export type FormulaAndFunctionProductAnalyticsExtendedDataSource =
14+
| typeof PRODUCT_ANALYTICS_EXTENDED
15+
| UnparsedObject;
16+
export const PRODUCT_ANALYTICS_EXTENDED = "product_analytics_extended";

0 commit comments

Comments
 (0)