Package com.datadog.api.client.v2.api

Class ProductAnalyticsApi

java.lang.Object

com.datadog.api.client.v2.api.ProductAnalyticsApi

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ProductAnalyticsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ProductAnalyticsApi()
ProductAnalyticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
ProductAnalyticsJourneyFunnelResponse	queryProductAnalyticsJourneyFunnel(ProductAnalyticsJourneyFunnelRequest body)	Compute journey funnel analysis.
CompletableFuture<ProductAnalyticsJourneyFunnelResponse>	queryProductAnalyticsJourneyFunnelAsync(ProductAnalyticsJourneyFunnelRequest body)	Compute journey funnel analysis.
ApiResponse<ProductAnalyticsJourneyFunnelResponse>	queryProductAnalyticsJourneyFunnelWithHttpInfo(ProductAnalyticsJourneyFunnelRequest body)	Compute a funnel over an ordered sequence of Product Analytics events.
CompletableFuture<ApiResponse<ProductAnalyticsJourneyFunnelResponse>>	queryProductAnalyticsJourneyFunnelWithHttpInfoAsync(ProductAnalyticsJourneyFunnelRequest body)	Compute journey funnel analysis.
ProductAnalyticsJourneyListResponse	queryProductAnalyticsJourneyList(ProductAnalyticsJourneyListRequest body)	List journey entities.
CompletableFuture<ProductAnalyticsJourneyListResponse>	queryProductAnalyticsJourneyListAsync(ProductAnalyticsJourneyListRequest body)	List journey entities.
ApiResponse<ProductAnalyticsJourneyListResponse>	queryProductAnalyticsJourneyListWithHttpInfo(ProductAnalyticsJourneyListRequest body)	Return the individual sessions that reached, or dropped off at, a given step of the journey.
CompletableFuture<ApiResponse<ProductAnalyticsJourneyListResponse>>	queryProductAnalyticsJourneyListWithHttpInfoAsync(ProductAnalyticsJourneyListRequest body)	List journey entities.
ProductAnalyticsJourneyScalarResponse	queryProductAnalyticsJourneyScalar(ProductAnalyticsJourneyScalarRequest body)	Compute journey scalar analytics.
CompletableFuture<ProductAnalyticsJourneyScalarResponse>	queryProductAnalyticsJourneyScalarAsync(ProductAnalyticsJourneyScalarRequest body)	Compute journey scalar analytics.
ApiResponse<ProductAnalyticsJourneyScalarResponse>	queryProductAnalyticsJourneyScalarWithHttpInfo(ProductAnalyticsJourneyScalarRequest body)	Compute scalar results for a journey query, such as the conversion count, the conversion rate, or the time to convert, optionally segmented by group-by facets.
CompletableFuture<ApiResponse<ProductAnalyticsJourneyScalarResponse>>	queryProductAnalyticsJourneyScalarWithHttpInfoAsync(ProductAnalyticsJourneyScalarRequest body)	Compute journey scalar analytics.
ProductAnalyticsJourneyTimeseriesResponse	queryProductAnalyticsJourneyTimeseries(ProductAnalyticsFormulaJourneyRequest body)	Compute journey timeseries analytics.
CompletableFuture<ProductAnalyticsJourneyTimeseriesResponse>	queryProductAnalyticsJourneyTimeseriesAsync(ProductAnalyticsFormulaJourneyRequest body)	Compute journey timeseries analytics.
ApiResponse<ProductAnalyticsJourneyTimeseriesResponse>	queryProductAnalyticsJourneyTimeseriesWithHttpInfo(ProductAnalyticsFormulaJourneyRequest body)	Compute timeseries results for a journey query.
CompletableFuture<ApiResponse<ProductAnalyticsJourneyTimeseriesResponse>>	queryProductAnalyticsJourneyTimeseriesWithHttpInfoAsync(ProductAnalyticsFormulaJourneyRequest body)	Compute journey timeseries analytics.
ProductAnalyticsAnalyticsListResponse	queryProductAnalyticsList(ProductAnalyticsAnalyticsListRequest body)	List analytics events.
CompletableFuture<ProductAnalyticsAnalyticsListResponse>	queryProductAnalyticsListAsync(ProductAnalyticsAnalyticsListRequest body)	List analytics events.
ApiResponse<ProductAnalyticsAnalyticsListResponse>	queryProductAnalyticsListWithHttpInfo(ProductAnalyticsAnalyticsListRequest body)	List the individual event records matching an analytics query.
CompletableFuture<ApiResponse<ProductAnalyticsAnalyticsListResponse>>	queryProductAnalyticsListWithHttpInfoAsync(ProductAnalyticsAnalyticsListRequest body)	List analytics events.
ProductAnalyticsRetentionGridResponse	queryProductAnalyticsRetentionGrid(ProductAnalyticsRetentionGridRequest body)	Compute a retention grid.
CompletableFuture<ProductAnalyticsRetentionGridResponse>	queryProductAnalyticsRetentionGridAsync(ProductAnalyticsRetentionGridRequest body)	Compute a retention grid.
ApiResponse<ProductAnalyticsRetentionGridResponse>	queryProductAnalyticsRetentionGridWithHttpInfo(ProductAnalyticsRetentionGridRequest body)	Compute a retention grid, showing how much of each cohort came back over each subsequent period.
CompletableFuture<ApiResponse<ProductAnalyticsRetentionGridResponse>>	queryProductAnalyticsRetentionGridWithHttpInfoAsync(ProductAnalyticsRetentionGridRequest body)	Compute a retention grid.
ProductAnalyticsRetentionListResponse	queryProductAnalyticsRetentionList(ProductAnalyticsRetentionListRequest body)	List the entities behind a retention cell.
CompletableFuture<ProductAnalyticsRetentionListResponse>	queryProductAnalyticsRetentionListAsync(ProductAnalyticsRetentionListRequest body)	List the entities behind a retention cell.
ApiResponse<ProductAnalyticsRetentionListResponse>	queryProductAnalyticsRetentionListWithHttpInfo(ProductAnalyticsRetentionListRequest body)	List the individual users or accounts counted in one cell of the retention grid.
CompletableFuture<ApiResponse<ProductAnalyticsRetentionListResponse>>	queryProductAnalyticsRetentionListWithHttpInfoAsync(ProductAnalyticsRetentionListRequest body)	List the entities behind a retention cell.
ProductAnalyticsScalarResponse	queryProductAnalyticsRetentionScalar(ProductAnalyticsFormulaRetentionRequest body)	Compute retention scalar values.
CompletableFuture<ProductAnalyticsScalarResponse>	queryProductAnalyticsRetentionScalarAsync(ProductAnalyticsFormulaRetentionRequest body)	Compute retention scalar values.
ApiResponse<ProductAnalyticsScalarResponse>	queryProductAnalyticsRetentionScalarWithHttpInfo(ProductAnalyticsFormulaRetentionRequest body)	Compute retention as a single value per group, suitable for a query value or top list widget.
CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>>	queryProductAnalyticsRetentionScalarWithHttpInfoAsync(ProductAnalyticsFormulaRetentionRequest body)	Compute retention scalar values.
ProductAnalyticsTimeseriesResponse	queryProductAnalyticsRetentionTimeseries(ProductAnalyticsFormulaRetentionRequest body)	Compute retention timeseries.
CompletableFuture<ProductAnalyticsTimeseriesResponse>	queryProductAnalyticsRetentionTimeseriesAsync(ProductAnalyticsFormulaRetentionRequest body)	Compute retention timeseries.
ApiResponse<ProductAnalyticsTimeseriesResponse>	queryProductAnalyticsRetentionTimeseriesWithHttpInfo(ProductAnalyticsFormulaRetentionRequest body)	Compute retention as a series of values over time, using the same query definition as the retention grid.
CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>>	queryProductAnalyticsRetentionTimeseriesWithHttpInfoAsync(ProductAnalyticsFormulaRetentionRequest body)	Compute retention timeseries.
ProductAnalyticsSankeyResponse	queryProductAnalyticsSankey(ProductAnalyticsSankeyRequest body)	Compute a Sankey diagram.
CompletableFuture<ProductAnalyticsSankeyResponse>	queryProductAnalyticsSankeyAsync(ProductAnalyticsSankeyRequest body)	Compute a Sankey diagram.
ApiResponse<ProductAnalyticsSankeyResponse>	queryProductAnalyticsSankeyWithHttpInfo(ProductAnalyticsSankeyRequest body)	Compute a Sankey diagram of how sessions flow between the values of two facets, showing where users continue and where they drop off at each step.
CompletableFuture<ApiResponse<ProductAnalyticsSankeyResponse>>	queryProductAnalyticsSankeyWithHttpInfoAsync(ProductAnalyticsSankeyRequest body)	Compute a Sankey diagram.
ProductAnalyticsScalarResponse	queryProductAnalyticsScalar(ProductAnalyticsAnalyticsRequest body)	Compute scalar analytics.
CompletableFuture<ProductAnalyticsScalarResponse>	queryProductAnalyticsScalarAsync(ProductAnalyticsAnalyticsRequest body)	Compute scalar analytics.
ApiResponse<ProductAnalyticsScalarResponse>	queryProductAnalyticsScalarWithHttpInfo(ProductAnalyticsAnalyticsRequest body)	Compute scalar analytics results for Product Analytics data.
CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>>	queryProductAnalyticsScalarWithHttpInfoAsync(ProductAnalyticsAnalyticsRequest body)	Compute scalar analytics.
ProductAnalyticsTimeseriesResponse	queryProductAnalyticsTimeseries(ProductAnalyticsAnalyticsRequest body)	Compute timeseries analytics.
CompletableFuture<ProductAnalyticsTimeseriesResponse>	queryProductAnalyticsTimeseriesAsync(ProductAnalyticsAnalyticsRequest body)	Compute timeseries analytics.
ApiResponse<ProductAnalyticsTimeseriesResponse>	queryProductAnalyticsTimeseriesWithHttpInfo(ProductAnalyticsAnalyticsRequest body)	Compute timeseries analytics results for Product Analytics data.
CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>>	queryProductAnalyticsTimeseriesWithHttpInfoAsync(ProductAnalyticsAnalyticsRequest body)	Compute timeseries analytics.
void	setApiClient(ApiClient apiClient)	Set the API client.
Object	submitProductAnalyticsEvent(ProductAnalyticsServerSideEventItem body)	Send server-side events.
CompletableFuture<Object>	submitProductAnalyticsEventAsync(ProductAnalyticsServerSideEventItem body)	Send server-side events.
ApiResponse<Object>	submitProductAnalyticsEventWithHttpInfo(ProductAnalyticsServerSideEventItem body)	Send server-side events to Product Analytics.
CompletableFuture<ApiResponse<Object>>	submitProductAnalyticsEventWithHttpInfoAsync(ProductAnalyticsServerSideEventItem body)	Send server-side events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProductAnalyticsApi

public ProductAnalyticsApi()

ProductAnalyticsApi

public ProductAnalyticsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

queryProductAnalyticsJourneyFunnel

public ProductAnalyticsJourneyFunnelResponse queryProductAnalyticsJourneyFunnel(ProductAnalyticsJourneyFunnelRequest body)
                                                                         throws ApiException

Compute journey funnel analysis.

See queryProductAnalyticsJourneyFunnelWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyFunnelRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsJourneyFunnelResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsJourneyFunnelAsync

public CompletableFuture<ProductAnalyticsJourneyFunnelResponse> queryProductAnalyticsJourneyFunnelAsync(ProductAnalyticsJourneyFunnelRequest body)

Compute journey funnel analysis.

See queryProductAnalyticsJourneyFunnelWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsJourneyFunnelRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsJourneyFunnelResponse>

queryProductAnalyticsJourneyFunnelWithHttpInfo

public ApiResponse<ProductAnalyticsJourneyFunnelResponse> queryProductAnalyticsJourneyFunnelWithHttpInfo(ProductAnalyticsJourneyFunnelRequest body)
                                                                                                  throws ApiException

Compute a funnel over an ordered sequence of Product Analytics events. Returns the per-step conversion counts, conversion rates, and elapsed times, optionally segmented by group-by facets.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsJourneyFunnelResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsJourneyFunnelWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsJourneyFunnelResponse>> queryProductAnalyticsJourneyFunnelWithHttpInfoAsync(ProductAnalyticsJourneyFunnelRequest body)

Compute journey funnel analysis.

See queryProductAnalyticsJourneyFunnelWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyFunnelRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsJourneyFunnelResponse>>

queryProductAnalyticsJourneyList

public ProductAnalyticsJourneyListResponse queryProductAnalyticsJourneyList(ProductAnalyticsJourneyListRequest body)
                                                                     throws ApiException

List journey entities.

See queryProductAnalyticsJourneyListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyListRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsJourneyListResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsJourneyListAsync

public CompletableFuture<ProductAnalyticsJourneyListResponse> queryProductAnalyticsJourneyListAsync(ProductAnalyticsJourneyListRequest body)

List journey entities.

See queryProductAnalyticsJourneyListWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsJourneyListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsJourneyListResponse>

queryProductAnalyticsJourneyListWithHttpInfo

public ApiResponse<ProductAnalyticsJourneyListResponse> queryProductAnalyticsJourneyListWithHttpInfo(ProductAnalyticsJourneyListRequest body)
                                                                                              throws ApiException

Return the individual sessions that reached, or dropped off at, a given step of the journey. Each row contains the identity join key, the event timestamp, and the columns requested in entity_columns.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsJourneyListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsJourneyListWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsJourneyListResponse>> queryProductAnalyticsJourneyListWithHttpInfoAsync(ProductAnalyticsJourneyListRequest body)

List journey entities.

See queryProductAnalyticsJourneyListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsJourneyListResponse>>

queryProductAnalyticsJourneyScalar

public ProductAnalyticsJourneyScalarResponse queryProductAnalyticsJourneyScalar(ProductAnalyticsJourneyScalarRequest body)
                                                                         throws ApiException

Compute journey scalar analytics.

See queryProductAnalyticsJourneyScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyScalarRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsJourneyScalarResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsJourneyScalarAsync

public CompletableFuture<ProductAnalyticsJourneyScalarResponse> queryProductAnalyticsJourneyScalarAsync(ProductAnalyticsJourneyScalarRequest body)

Compute journey scalar analytics.

See queryProductAnalyticsJourneyScalarWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsJourneyScalarRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsJourneyScalarResponse>

queryProductAnalyticsJourneyScalarWithHttpInfo

public ApiResponse<ProductAnalyticsJourneyScalarResponse> queryProductAnalyticsJourneyScalarWithHttpInfo(ProductAnalyticsJourneyScalarRequest body)
                                                                                                  throws ApiException

Compute scalar results for a journey query, such as the conversion count, the conversion rate, or the time to convert, optionally segmented by group-by facets.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsJourneyScalarResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsJourneyScalarWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsJourneyScalarResponse>> queryProductAnalyticsJourneyScalarWithHttpInfoAsync(ProductAnalyticsJourneyScalarRequest body)

Compute journey scalar analytics.

See queryProductAnalyticsJourneyScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsJourneyScalarRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsJourneyScalarResponse>>

queryProductAnalyticsJourneyTimeseries

public ProductAnalyticsJourneyTimeseriesResponse queryProductAnalyticsJourneyTimeseries(ProductAnalyticsFormulaJourneyRequest body)
                                                                                 throws ApiException

Compute journey timeseries analytics.

See queryProductAnalyticsJourneyTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaJourneyRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsJourneyTimeseriesResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsJourneyTimeseriesAsync

public CompletableFuture<ProductAnalyticsJourneyTimeseriesResponse> queryProductAnalyticsJourneyTimeseriesAsync(ProductAnalyticsFormulaJourneyRequest body)

Compute journey timeseries analytics.

See queryProductAnalyticsJourneyTimeseriesWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsFormulaJourneyRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsJourneyTimeseriesResponse>

queryProductAnalyticsJourneyTimeseriesWithHttpInfo

public ApiResponse<ProductAnalyticsJourneyTimeseriesResponse> queryProductAnalyticsJourneyTimeseriesWithHttpInfo(ProductAnalyticsFormulaJourneyRequest body)
                                                                                                          throws ApiException

Compute timeseries results for a journey query. Returns one series per group-by combination, bucketed by the requested interval.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsJourneyTimeseriesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsJourneyTimeseriesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsJourneyTimeseriesResponse>> queryProductAnalyticsJourneyTimeseriesWithHttpInfoAsync(ProductAnalyticsFormulaJourneyRequest body)

Compute journey timeseries analytics.

See queryProductAnalyticsJourneyTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaJourneyRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsJourneyTimeseriesResponse>>

queryProductAnalyticsList

public ProductAnalyticsAnalyticsListResponse queryProductAnalyticsList(ProductAnalyticsAnalyticsListRequest body)
                                                                throws ApiException

List analytics events.

See queryProductAnalyticsListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsAnalyticsListResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsListAsync

public CompletableFuture<ProductAnalyticsAnalyticsListResponse> queryProductAnalyticsListAsync(ProductAnalyticsAnalyticsListRequest body)

List analytics events.

See queryProductAnalyticsListWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsAnalyticsListResponse>

queryProductAnalyticsListWithHttpInfo

public ApiResponse<ProductAnalyticsAnalyticsListResponse> queryProductAnalyticsListWithHttpInfo(ProductAnalyticsAnalyticsListRequest body)
                                                                                         throws ApiException

List the individual event records matching an analytics query. Use columns to choose the attributes returned on each row, sort to order the rows, and limit to cap how many are returned.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsAnalyticsListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsListWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsAnalyticsListResponse>> queryProductAnalyticsListWithHttpInfoAsync(ProductAnalyticsAnalyticsListRequest body)

List analytics events.

See queryProductAnalyticsListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsAnalyticsListResponse>>

queryProductAnalyticsRetentionGrid

public ProductAnalyticsRetentionGridResponse queryProductAnalyticsRetentionGrid(ProductAnalyticsRetentionGridRequest body)
                                                                         throws ApiException

Compute a retention grid.

See queryProductAnalyticsRetentionGridWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsRetentionGridRequest).

Parameters:

body - The retention grid query. (required)

Returns:

ProductAnalyticsRetentionGridResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsRetentionGridAsync

public CompletableFuture<ProductAnalyticsRetentionGridResponse> queryProductAnalyticsRetentionGridAsync(ProductAnalyticsRetentionGridRequest body)

Compute a retention grid.

See queryProductAnalyticsRetentionGridWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsRetentionGridRequest).

Parameters:

body - The retention grid query. (required)

Returns:

CompletableFuture<ProductAnalyticsRetentionGridResponse>

queryProductAnalyticsRetentionGridWithHttpInfo

public ApiResponse<ProductAnalyticsRetentionGridResponse> queryProductAnalyticsRetentionGridWithHttpInfo(ProductAnalyticsRetentionGridRequest body)
                                                                                                  throws ApiException

Compute a retention grid, showing how much of each cohort came back over each subsequent period. Rows are cohorts, columns are return periods, and each cell holds the count and rate of entities that returned.

Parameters:

body - The retention grid query. (required)

Returns:

ApiResponse<ProductAnalyticsRetentionGridResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsRetentionGridWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsRetentionGridResponse>> queryProductAnalyticsRetentionGridWithHttpInfoAsync(ProductAnalyticsRetentionGridRequest body)

Compute a retention grid.

See queryProductAnalyticsRetentionGridWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsRetentionGridRequest).

Parameters:

body - The retention grid query. (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsRetentionGridResponse>>

queryProductAnalyticsRetentionList

public ProductAnalyticsRetentionListResponse queryProductAnalyticsRetentionList(ProductAnalyticsRetentionListRequest body)
                                                                         throws ApiException

List the entities behind a retention cell.

See queryProductAnalyticsRetentionListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsRetentionListRequest).

Parameters:

body - The retention list query. (required)

Returns:

ProductAnalyticsRetentionListResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsRetentionListAsync

public CompletableFuture<ProductAnalyticsRetentionListResponse> queryProductAnalyticsRetentionListAsync(ProductAnalyticsRetentionListRequest body)

List the entities behind a retention cell.

See queryProductAnalyticsRetentionListWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsRetentionListRequest).

Parameters:

body - The retention list query. (required)

Returns:

CompletableFuture<ProductAnalyticsRetentionListResponse>

queryProductAnalyticsRetentionListWithHttpInfo

public ApiResponse<ProductAnalyticsRetentionListResponse> queryProductAnalyticsRetentionListWithHttpInfo(ProductAnalyticsRetentionListRequest body)
                                                                                                  throws ApiException

List the individual users or accounts counted in one cell of the retention grid. Set computation_scope to the cohort and return period you want to examine.

Parameters:

body - The retention list query. (required)

Returns:

ApiResponse<ProductAnalyticsRetentionListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsRetentionListWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsRetentionListResponse>> queryProductAnalyticsRetentionListWithHttpInfoAsync(ProductAnalyticsRetentionListRequest body)

List the entities behind a retention cell.

See queryProductAnalyticsRetentionListWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsRetentionListRequest).

Parameters:

body - The retention list query. (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsRetentionListResponse>>

queryProductAnalyticsRetentionScalar

public ProductAnalyticsScalarResponse queryProductAnalyticsRetentionScalar(ProductAnalyticsFormulaRetentionRequest body)
                                                                    throws ApiException

Compute retention scalar values.

See queryProductAnalyticsRetentionScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention scalar query. (required)

Returns:

ProductAnalyticsScalarResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsRetentionScalarAsync

public CompletableFuture<ProductAnalyticsScalarResponse> queryProductAnalyticsRetentionScalarAsync(ProductAnalyticsFormulaRetentionRequest body)

Compute retention scalar values.

See queryProductAnalyticsRetentionScalarWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention scalar query. (required)

Returns:

CompletableFuture<ProductAnalyticsScalarResponse>

queryProductAnalyticsRetentionScalarWithHttpInfo

public ApiResponse<ProductAnalyticsScalarResponse> queryProductAnalyticsRetentionScalarWithHttpInfo(ProductAnalyticsFormulaRetentionRequest body)
                                                                                             throws ApiException

Compute retention as a single value per group, suitable for a query value or top list widget.

Parameters:

body - The retention scalar query. (required)

Returns:

ApiResponse<ProductAnalyticsScalarResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsRetentionScalarWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>> queryProductAnalyticsRetentionScalarWithHttpInfoAsync(ProductAnalyticsFormulaRetentionRequest body)

Compute retention scalar values.

See queryProductAnalyticsRetentionScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention scalar query. (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>>

queryProductAnalyticsRetentionTimeseries

public ProductAnalyticsTimeseriesResponse queryProductAnalyticsRetentionTimeseries(ProductAnalyticsFormulaRetentionRequest body)
                                                                            throws ApiException

Compute retention timeseries.

See queryProductAnalyticsRetentionTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention timeseries query. (required)

Returns:

ProductAnalyticsTimeseriesResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsRetentionTimeseriesAsync

public CompletableFuture<ProductAnalyticsTimeseriesResponse> queryProductAnalyticsRetentionTimeseriesAsync(ProductAnalyticsFormulaRetentionRequest body)

Compute retention timeseries.

See queryProductAnalyticsRetentionTimeseriesWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention timeseries query. (required)

Returns:

CompletableFuture<ProductAnalyticsTimeseriesResponse>

queryProductAnalyticsRetentionTimeseriesWithHttpInfo

public ApiResponse<ProductAnalyticsTimeseriesResponse> queryProductAnalyticsRetentionTimeseriesWithHttpInfo(ProductAnalyticsFormulaRetentionRequest body)
                                                                                                     throws ApiException

Compute retention as a series of values over time, using the same query definition as the retention grid.

Parameters:

body - The retention timeseries query. (required)

Returns:

ApiResponse<ProductAnalyticsTimeseriesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsRetentionTimeseriesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>> queryProductAnalyticsRetentionTimeseriesWithHttpInfoAsync(ProductAnalyticsFormulaRetentionRequest body)

Compute retention timeseries.

See queryProductAnalyticsRetentionTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsFormulaRetentionRequest).

Parameters:

body - The retention timeseries query. (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>>

queryProductAnalyticsSankey

public ProductAnalyticsSankeyResponse queryProductAnalyticsSankey(ProductAnalyticsSankeyRequest body)
                                                           throws ApiException

Compute a Sankey diagram.

See queryProductAnalyticsSankeyWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequest).

Parameters:

body - The Sankey diagram query. (required)

Returns:

ProductAnalyticsSankeyResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsSankeyAsync

public CompletableFuture<ProductAnalyticsSankeyResponse> queryProductAnalyticsSankeyAsync(ProductAnalyticsSankeyRequest body)

Compute a Sankey diagram.

See queryProductAnalyticsSankeyWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequest).

Parameters:

body - The Sankey diagram query. (required)

Returns:

CompletableFuture<ProductAnalyticsSankeyResponse>

queryProductAnalyticsSankeyWithHttpInfo

public ApiResponse<ProductAnalyticsSankeyResponse> queryProductAnalyticsSankeyWithHttpInfo(ProductAnalyticsSankeyRequest body)
                                                                                    throws ApiException

Compute a Sankey diagram of how sessions flow between the values of two facets, showing where users continue and where they drop off at each step.

Parameters:

body - The Sankey diagram query. (required)

Returns:

ApiResponse<ProductAnalyticsSankeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsSankeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsSankeyResponse>> queryProductAnalyticsSankeyWithHttpInfoAsync(ProductAnalyticsSankeyRequest body)

Compute a Sankey diagram.

See queryProductAnalyticsSankeyWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsSankeyRequest).

Parameters:

body - The Sankey diagram query. (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsSankeyResponse>>

queryProductAnalyticsScalar

public ProductAnalyticsScalarResponse queryProductAnalyticsScalar(ProductAnalyticsAnalyticsRequest body)
                                                           throws ApiException

Compute scalar analytics.

See queryProductAnalyticsScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsScalarResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsScalarAsync

public CompletableFuture<ProductAnalyticsScalarResponse> queryProductAnalyticsScalarAsync(ProductAnalyticsAnalyticsRequest body)

Compute scalar analytics.

See queryProductAnalyticsScalarWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsScalarResponse>

queryProductAnalyticsScalarWithHttpInfo

public ApiResponse<ProductAnalyticsScalarResponse> queryProductAnalyticsScalarWithHttpInfo(ProductAnalyticsAnalyticsRequest body)
                                                                                    throws ApiException

Compute scalar analytics results for Product Analytics data. Returns aggregated values (counts, averages, percentiles) optionally grouped by facets.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsScalarResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsScalarWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>> queryProductAnalyticsScalarWithHttpInfoAsync(ProductAnalyticsAnalyticsRequest body)

Compute scalar analytics.

See queryProductAnalyticsScalarWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsScalarResponse>>

queryProductAnalyticsTimeseries

public ProductAnalyticsTimeseriesResponse queryProductAnalyticsTimeseries(ProductAnalyticsAnalyticsRequest body)
                                                                   throws ApiException

Compute timeseries analytics.

See queryProductAnalyticsTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

ProductAnalyticsTimeseriesResponse

Throws:

ApiException - if fails to make API call

queryProductAnalyticsTimeseriesAsync

public CompletableFuture<ProductAnalyticsTimeseriesResponse> queryProductAnalyticsTimeseriesAsync(ProductAnalyticsAnalyticsRequest body)

Compute timeseries analytics.

See queryProductAnalyticsTimeseriesWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ProductAnalyticsTimeseriesResponse>

queryProductAnalyticsTimeseriesWithHttpInfo

public ApiResponse<ProductAnalyticsTimeseriesResponse> queryProductAnalyticsTimeseriesWithHttpInfo(ProductAnalyticsAnalyticsRequest body)
                                                                                            throws ApiException

Compute timeseries analytics results for Product Analytics data. Returns time-bucketed values for charts and trend analysis. The compute.interval field (milliseconds) is required for time bucketing.

Parameters:

body - (required)

Returns:

ApiResponse<ProductAnalyticsTimeseriesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

queryProductAnalyticsTimeseriesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>> queryProductAnalyticsTimeseriesWithHttpInfoAsync(ProductAnalyticsAnalyticsRequest body)

Compute timeseries analytics.

See queryProductAnalyticsTimeseriesWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ProductAnalyticsTimeseriesResponse>>

submitProductAnalyticsEvent

public Object submitProductAnalyticsEvent(ProductAnalyticsServerSideEventItem body)
                                   throws ApiException

Send server-side events.

See submitProductAnalyticsEventWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsServerSideEventItem).

Parameters:

body - Server-side event to send (JSON format). (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

submitProductAnalyticsEventAsync

public CompletableFuture<Object> submitProductAnalyticsEventAsync(ProductAnalyticsServerSideEventItem body)

Send server-side events.

See submitProductAnalyticsEventWithHttpInfoAsync(com.datadog.api.client.v2.model.ProductAnalyticsServerSideEventItem).

Parameters:

body - Server-side event to send (JSON format). (required)

Returns:

CompletableFuture<Object>

submitProductAnalyticsEventWithHttpInfo

public ApiResponse<Object> submitProductAnalyticsEventWithHttpInfo(ProductAnalyticsServerSideEventItem body)
                                                            throws ApiException

Send server-side events to Product Analytics. Server-side events are retained for 15 months.

Server-Side events in Product Analytics are helpful for tracking events that occur on the server, as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs. This allows for a more comprehensive view of the user journey by including actions that happen on the server. Typical examples could be checkout.completed or payment.processed.

Ingested server-side events are integrated into Product Analytics to allow users to select and filter these events in the event picker, similar to how views or actions are handled.

Requirements: - At least one of usr, account, or session must be provided with a valid ID. - The application.id must reference a Product Analytics-enabled application.

Custom Attributes: Any additional fields in the payload are flattened and searchable as facets. For example, a payload with {"customer": {"tier": "premium"}} is searchable with the syntax @customer.tier:premium in Datadog.

The status codes answered by the HTTP API are: - 202: Accepted: The request has been accepted for processing - 400: Bad request (likely an issue in the payload formatting) - 401: Unauthorized (likely a missing API Key) - 403: Permission issue (likely using an invalid API Key) - 408: Request Timeout, request should be retried after some time - 413: Payload too large (batch is above 5MB uncompressed) - 429: Too Many Requests, request should be retried after some time - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time

Parameters:

body - Server-side event to send (JSON format). (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Request accepted for processing (always 202 empty JSON).	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
413	Payload Too Large	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

submitProductAnalyticsEventWithHttpInfoAsync

public CompletableFuture<ApiResponse<Object>> submitProductAnalyticsEventWithHttpInfoAsync(ProductAnalyticsServerSideEventItem body)

Send server-side events.

See submitProductAnalyticsEventWithHttpInfo(com.datadog.api.client.v2.model.ProductAnalyticsServerSideEventItem).

Parameters:

body - Server-side event to send (JSON format). (required)

Returns:

CompletableFuture<ApiResponse<Object>>