com.datadog.api.client.v2.api

Class ProductAnalyticsApi

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
ProductAnalyticsApi()
ProductAnalyticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
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 Detail

ProductAnalyticsApi

public ProductAnalyticsApi()

ProductAnalyticsApi

public ProductAnalyticsApi(ApiClient apiClient)

Method Detail

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

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>>