Skip to content

Publish Product Analytics journey, retention, and Sankey queries to public docs #4182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Publish Product Analytics journey, retention, and Sankey queries to public docs #4182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82474,7 +82474,10 @@ components:
$ref: "#/components/schemas/ProductAnalyticsGroupBy"
type: array
indexes:
description: Restrict the query to specific indexes. Max 1 entry.
deprecated: true
description: |-
Deprecated. Index selection is a rollout detail and will be removed.
Do not set this field.
items:
description: Index name to restrict the query to.
type: string
Expand Down Expand Up @@ -82512,6 +82515,10 @@ components:
properties:
enforced_execution_type:
$ref: "#/components/schemas/ProductAnalyticsExecutionType"
deprecated: true
description: |-
Deprecated. Selects the internal query execution infrastructure and will be removed.
Do not set this field.
from:
description: Start time in epoch milliseconds. Must be less than `to`.
example: 1771232048460
Expand All @@ -82520,7 +82527,7 @@ components:
query:
$ref: "#/components/schemas/ProductAnalyticsAnalyticsQuery"
request_id:
description: Optional request ID for multi-step query continuation.
description: Unique identifier of the query.
type: string
to:
description: End time in epoch milliseconds.
Expand Down Expand Up @@ -82633,7 +82640,9 @@ components:
example: count
type: string
interval:
description: Time bucket size in milliseconds. Required for timeseries queries.
description: |-
Time bucket size in milliseconds. Required for timeseries queries; ignored by the
scalar endpoint, which returns a single value.
example: 3600000
format: int64
type: integer
Expand Down Expand Up @@ -82796,7 +82805,7 @@ components:
description: Metadata for a Product Analytics query response.
properties:
request_id:
description: Unique identifier for the request, used for multi-step query continuation.
description: Unique identifier of the query.
type: string
status:
$ref: "#/components/schemas/ProductAnalyticsResponseMetaStatus"
Expand Down Expand Up @@ -83016,7 +83025,9 @@ components:
$ref: "#/components/schemas/ProductAnalyticsResponseMeta"
type: object
ProductAnalyticsTimeseriesResponseAttributes:
description: Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions.
description: |-
Attributes of a timeseries analytics response, containing series data, timestamps, and
interval definitions.
properties:
intervals:
description: Interval definitions describing the time buckets used in the response.
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/ProductAnalyticsAnalyticsQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,17 +162,20 @@ public ProductAnalyticsAnalyticsQuery addIndexesItem(String indexesItem) {
}

/**
* Restrict the query to specific indexes. Max 1 entry.
* Deprecated. Index selection is a rollout detail and will be removed. Do not set this field.
*
* @return indexes
* @deprecated
*/
@Deprecated
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_INDEXES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<String> getIndexes() {
return indexes;
}

@Deprecated
public void setIndexes(List<String> indexes) {
this.indexes = indexes;
}
Expand Down
2 changes: 1 addition & 1 deletion ...main/java/com/datadog/api/client/v2/model/ProductAnalyticsAnalyticsRequestAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ public ProductAnalyticsAnalyticsRequestAttributes requestId(String requestId) {
}

/**
* Optional request ID for multi-step query continuation.
* Unique identifier of the query.
*
* @return requestId
*/
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/ProductAnalyticsCompute.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ public ProductAnalyticsCompute interval(Long interval) {
}

/**
* Time bucket size in milliseconds. Required for timeseries queries.
* Time bucket size in milliseconds. Required for timeseries queries; ignored by the scalar
* endpoint, which returns a single value.
*
* @return interval
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/datadog/api/client/v2/model/ProductAnalyticsResponseMeta.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public ProductAnalyticsResponseMeta requestId(String requestId) {
}

/**
* Unique identifier for the request, used for multi-step query continuation.
* Unique identifier of the query.
*
* @return requestId
*/
Expand Down
Loading