Skip to content

Commit eded9cd

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit de14407 of spec repo
1 parent 14d9e5d commit eded9cd

23 files changed

+3885
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48417,6 +48417,19 @@ components:
4841748417
type:
4841848418
type: string
4841948419
type: object
48420+
ProductAnalyticsJoinKeys:
48421+
description: Join key configuration for correlating events.
48422+
properties:
48423+
primary:
48424+
description: The primary join key facet.
48425+
example: '@session.id'
48426+
type: string
48427+
secondary:
48428+
description: Secondary join key facets.
48429+
items:
48430+
type: string
48431+
type: array
48432+
type: object
4842048433
ProductAnalyticsOccurrenceFilter:
4842148434
description: Filter for occurrence-based queries.
4842248435
properties:
@@ -48484,6 +48497,273 @@ components:
4848448497
- DONE
4848548498
- RUNNING
4848648499
- TIMEOUT
48500+
ProductAnalyticsSampling:
48501+
description: Sampling configuration.
48502+
properties:
48503+
enabled:
48504+
default: false
48505+
description: Whether sampling is enabled.
48506+
type: boolean
48507+
type: object
48508+
ProductAnalyticsSankeyAggregatedNode:
48509+
description: A node aggregated into an "other" node.
48510+
properties:
48511+
id:
48512+
type: string
48513+
incoming_value:
48514+
format: int64
48515+
type: integer
48516+
name:
48517+
type: string
48518+
outgoing_value:
48519+
format: int64
48520+
type: integer
48521+
type:
48522+
$ref: '#/components/schemas/ProductAnalyticsSankeyAggregatedNodeType'
48523+
value:
48524+
format: int64
48525+
type: integer
48526+
type: object
48527+
ProductAnalyticsSankeyAggregatedNodeType:
48528+
enum:
48529+
- aggregated
48530+
type: string
48531+
x-enum-varnames:
48532+
- AGGREGATED
48533+
ProductAnalyticsSankeyDefinition:
48534+
description: 'Sankey visualization definition. Set either `source` or `target`,
48535+
not both.
48536+
48537+
Use `source` for forward flow (where do users go after this page?) or
48538+
48539+
`target` for backward flow (where did users come from?).'
48540+
properties:
48541+
entries_per_step:
48542+
default: 5
48543+
description: Number of page entries per step. Default 5, max 10.
48544+
example: 5
48545+
format: int64
48546+
maximum: 10
48547+
type: integer
48548+
number_of_steps:
48549+
default: 5
48550+
description: Number of steps in the flow. Default 5, max 10.
48551+
example: 5
48552+
format: int64
48553+
maximum: 10
48554+
type: integer
48555+
source:
48556+
description: The source page for forward flow analysis. Use "*" for all
48557+
pages.
48558+
example: /logs
48559+
type: string
48560+
target:
48561+
description: The target page for backward flow analysis.
48562+
type: string
48563+
type: object
48564+
ProductAnalyticsSankeyLink:
48565+
description: A link between two nodes in the Sankey diagram.
48566+
properties:
48567+
column:
48568+
description: The step column of the source node.
48569+
format: int64
48570+
type: integer
48571+
id:
48572+
type: string
48573+
source:
48574+
description: The source node ID.
48575+
type: string
48576+
target:
48577+
description: The target node ID.
48578+
type: string
48579+
value:
48580+
description: The number of sessions through this link.
48581+
format: int64
48582+
type: integer
48583+
type: object
48584+
ProductAnalyticsSankeyNode:
48585+
description: A node in the Sankey diagram representing a page or aggregation.
48586+
properties:
48587+
aggregated_nodes:
48588+
description: Nodes aggregated into this node (for "other" type).
48589+
items:
48590+
$ref: '#/components/schemas/ProductAnalyticsSankeyAggregatedNode'
48591+
type: array
48592+
column:
48593+
description: The step column (0-indexed).
48594+
format: int64
48595+
type: integer
48596+
dropoff_value:
48597+
format: int64
48598+
type: integer
48599+
id:
48600+
type: string
48601+
incoming_value:
48602+
format: int64
48603+
type: integer
48604+
name:
48605+
description: The page name.
48606+
example: /logs
48607+
type: string
48608+
outgoing_value:
48609+
format: int64
48610+
type: integer
48611+
type:
48612+
$ref: '#/components/schemas/ProductAnalyticsSankeyNodeType'
48613+
value:
48614+
description: The number of sessions through this node.
48615+
format: int64
48616+
type: integer
48617+
type: object
48618+
ProductAnalyticsSankeyNodeType:
48619+
description: Node type.
48620+
enum:
48621+
- regular
48622+
- other
48623+
- dropoff
48624+
type: string
48625+
x-enum-varnames:
48626+
- REGULAR
48627+
- OTHER
48628+
- DROPOFF
48629+
ProductAnalyticsSankeyRequest:
48630+
description: Request for computing a Sankey flow analysis.
48631+
example:
48632+
data:
48633+
attributes:
48634+
data_source: product_analytics
48635+
definition:
48636+
entries_per_step: 5
48637+
number_of_steps: 5
48638+
source: /logs
48639+
target: ''
48640+
search:
48641+
join_keys:
48642+
primary: '@session.id'
48643+
query: '@type:view'
48644+
time:
48645+
from: 1771232048460
48646+
to: 1771836848262
48647+
type: sankey_request
48648+
properties:
48649+
data:
48650+
$ref: '#/components/schemas/ProductAnalyticsSankeyRequestData'
48651+
required:
48652+
- data
48653+
type: object
48654+
ProductAnalyticsSankeyRequestAttributes:
48655+
description: Attributes for a Sankey request.
48656+
properties:
48657+
data_source:
48658+
description: The data source for the Sankey query.
48659+
example: product_analytics
48660+
type: string
48661+
definition:
48662+
$ref: '#/components/schemas/ProductAnalyticsSankeyDefinition'
48663+
enforced_execution_type:
48664+
$ref: '#/components/schemas/ProductAnalyticsExecutionType'
48665+
request_id:
48666+
type: string
48667+
sampling:
48668+
$ref: '#/components/schemas/ProductAnalyticsSampling'
48669+
search:
48670+
$ref: '#/components/schemas/ProductAnalyticsSankeySearch'
48671+
time:
48672+
$ref: '#/components/schemas/ProductAnalyticsSankeyTime'
48673+
required:
48674+
- time
48675+
- search
48676+
- definition
48677+
- data_source
48678+
type: object
48679+
ProductAnalyticsSankeyRequestData:
48680+
properties:
48681+
attributes:
48682+
$ref: '#/components/schemas/ProductAnalyticsSankeyRequestAttributes'
48683+
type:
48684+
$ref: '#/components/schemas/ProductAnalyticsSankeyRequestType'
48685+
required:
48686+
- type
48687+
- attributes
48688+
type: object
48689+
ProductAnalyticsSankeyRequestType:
48690+
enum:
48691+
- sankey_request
48692+
example: sankey_request
48693+
type: string
48694+
x-enum-varnames:
48695+
- SANKEY_REQUEST
48696+
ProductAnalyticsSankeyResponse:
48697+
description: Response for a Sankey flow analysis.
48698+
properties:
48699+
data:
48700+
$ref: '#/components/schemas/ProductAnalyticsSankeyResponseData'
48701+
meta:
48702+
$ref: '#/components/schemas/ProductAnalyticsResponseMeta'
48703+
type: object
48704+
ProductAnalyticsSankeyResponseAttributes:
48705+
properties:
48706+
links:
48707+
description: The links (flows) between nodes.
48708+
items:
48709+
$ref: '#/components/schemas/ProductAnalyticsSankeyLink'
48710+
type: array
48711+
nodes:
48712+
description: The nodes (pages) in the Sankey diagram.
48713+
items:
48714+
$ref: '#/components/schemas/ProductAnalyticsSankeyNode'
48715+
type: array
48716+
type: object
48717+
ProductAnalyticsSankeyResponseData:
48718+
properties:
48719+
attributes:
48720+
$ref: '#/components/schemas/ProductAnalyticsSankeyResponseAttributes'
48721+
id:
48722+
type: string
48723+
type:
48724+
$ref: '#/components/schemas/ProductAnalyticsSankeyResponseType'
48725+
type: object
48726+
ProductAnalyticsSankeyResponseType:
48727+
enum:
48728+
- sankey_response
48729+
type: string
48730+
x-enum-varnames:
48731+
- SANKEY_RESPONSE
48732+
ProductAnalyticsSankeySearch:
48733+
description: Search parameters for a Sankey query.
48734+
properties:
48735+
audience_filters:
48736+
$ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
48737+
join_keys:
48738+
$ref: '#/components/schemas/ProductAnalyticsJoinKeys'
48739+
occurrences:
48740+
$ref: '#/components/schemas/ProductAnalyticsOccurrenceFilter'
48741+
query:
48742+
description: The search query. Cannot be empty.
48743+
example: '@type:view'
48744+
type: string
48745+
subquery_id:
48746+
type: string
48747+
required:
48748+
- query
48749+
type: object
48750+
ProductAnalyticsSankeyTime:
48751+
description: Time range for the Sankey query.
48752+
properties:
48753+
from:
48754+
description: Start time in epoch milliseconds.
48755+
example: 0
48756+
format: int64
48757+
type: integer
48758+
to:
48759+
description: End time in epoch milliseconds.
48760+
example: 0
48761+
format: int64
48762+
type: integer
48763+
required:
48764+
- from
48765+
- to
48766+
type: object
4848748767
ProductAnalyticsScalarColumn:
4848848768
description: A column in a scalar response.
4848948769
properties:
@@ -93205,6 +93485,43 @@ paths:
9320593485
operator: OR
9320693486
permissions:
9320793487
- rum_apps_read
93488+
/api/v2/product-analytics/sankey:
93489+
post:
93490+
description: 'Compute a Sankey flow analysis showing how users navigate between
93491+
pages.
93492+
93493+
Specify either a `source` page (forward flow) or `target` page (backward flow),
93494+
but not both.
93495+
93496+
Maximum 10 steps and 10 entries per step.'
93497+
operationId: QueryProductAnalyticsSankey
93498+
requestBody:
93499+
content:
93500+
application/json:
93501+
schema:
93502+
$ref: '#/components/schemas/ProductAnalyticsSankeyRequest'
93503+
required: true
93504+
responses:
93505+
'200':
93506+
content:
93507+
application/json:
93508+
schema:
93509+
$ref: '#/components/schemas/ProductAnalyticsSankeyResponse'
93510+
description: OK
93511+
'400':
93512+
$ref: '#/components/responses/BadRequestResponse'
93513+
'403':
93514+
$ref: '#/components/responses/NotAuthorizedResponse'
93515+
'429':
93516+
$ref: '#/components/responses/TooManyRequestsResponse'
93517+
summary: Compute Sankey flow analysis
93518+
tags:
93519+
- Product Analytics
93520+
x-codegen-request-body-name: body
93521+
x-permission:
93522+
operator: OR
93523+
permissions:
93524+
- rum_apps_read
9320893525
/api/v2/product-analytics/users/event_filtered_query:
9320993526
post:
9321093527
description: Query users filtered by both user properties and event platform
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Compute Sankey flow analysis returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.ProductAnalyticsApi;
6+
import com.datadog.api.client.v2.model.ProductAnalyticsJoinKeys;
7+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyDefinition;
8+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequest;
9+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequestAttributes;
10+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequestData;
11+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequestType;
12+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyResponse;
13+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeySearch;
14+
import com.datadog.api.client.v2.model.ProductAnalyticsSankeyTime;
15+
16+
public class Example {
17+
public static void main(String[] args) {
18+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
19+
ProductAnalyticsApi apiInstance = new ProductAnalyticsApi(defaultClient);
20+
21+
ProductAnalyticsSankeyRequest body =
22+
new ProductAnalyticsSankeyRequest()
23+
.data(
24+
new ProductAnalyticsSankeyRequestData()
25+
.attributes(
26+
new ProductAnalyticsSankeyRequestAttributes()
27+
.dataSource("product_analytics")
28+
.definition(
29+
new ProductAnalyticsSankeyDefinition()
30+
.entriesPerStep(5L)
31+
.numberOfSteps(5L)
32+
.source("/logs")
33+
.target(""))
34+
.search(
35+
new ProductAnalyticsSankeySearch()
36+
.joinKeys(new ProductAnalyticsJoinKeys().primary("@session.id"))
37+
.query("@type:view"))
38+
.time(
39+
new ProductAnalyticsSankeyTime()
40+
.from(1771232048460L)
41+
.to(1771836848262L)))
42+
.type(ProductAnalyticsSankeyRequestType.SANKEY_REQUEST));
43+
44+
try {
45+
ProductAnalyticsSankeyResponse result = apiInstance.queryProductAnalyticsSankey(body);
46+
System.out.println(result);
47+
} catch (ApiException e) {
48+
System.err.println("Exception when calling ProductAnalyticsApi#queryProductAnalyticsSankey");
49+
System.err.println("Status code: " + e.getCode());
50+
System.err.println("Reason: " + e.getResponseBody());
51+
System.err.println("Response headers: " + e.getResponseHeaders());
52+
e.printStackTrace();
53+
}
54+
}
55+
}

0 commit comments

Comments
 (0)