Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ def __init__(
:param group_by: Group-by rules for segmenting results.
:type group_by: [ProductAnalyticsGroupBy], optional

:param indexes: Restrict the query to specific indexes. Max 1 entry.
:param indexes: Deprecated. Index selection is a rollout detail and will be removed.
Do not set this field. **Deprecated**.
:type indexes: [str], optional

:param query: A query definition discriminated by the ``data_source`` field.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def __init__(
:param query: The analytics query definition containing a base query, compute rule, and optional grouping.
:type query: ProductAnalyticsAnalyticsQuery

:param request_id: Optional request ID for multi-step query continuation.
:param request_id: Unique identifier of the query.
:type request_id: str, optional

:param to: End time in epoch milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ def __init__(
:param aggregation: The aggregation function (count, cardinality, avg, sum, min, max, etc.).
:type aggregation: str

:param interval: Time bucket size in milliseconds. Required for timeseries queries.
:param interval: Time bucket size in milliseconds. Required for timeseries queries; ignored by the
scalar endpoint, which returns a single value.
:type interval: int, optional

:param metric: The metric to aggregate on. Required for non-count aggregations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def __init__(
"""
Metadata for a Product Analytics query response.

:param request_id: Unique identifier for the request, used for multi-step query continuation.
:param request_id: Unique identifier of the query.
:type request_id: str, optional

:param status: The execution status of a Product Analytics query.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ def __init__(
**kwargs,
):
"""
Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions.
Attributes of a timeseries analytics response, containing series data, timestamps, and
interval definitions.

:param intervals: Interval definitions describing the time buckets used in the response.
:type intervals: [ProductAnalyticsInterval], optional
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ def __init__(
"""
Data object for a timeseries analytics response.

:param attributes: Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions.
:param attributes: Attributes of a timeseries analytics response, containing series data, timestamps, and
interval definitions.
:type attributes: ProductAnalyticsTimeseriesResponseAttributes, optional

:param id: Unique identifier for this response data object.
Expand Down
Loading