product_analytics_events
Creates, updates, deletes, gets or lists a product_analytics_events resource.
Overview
| Name | product_analytics_events |
| Type | Resource |
| Id | datadog.digital_experience.product_analytics_events |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
submit_product_analytics_event | exec | application, event, type | Send server-side events to Product Analytics. Server-side events are retained for 15 months.<br /><br />Server-Side events in Product Analytics are helpful for tracking events that occur on the server,<br />as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs.<br />This allows for a more comprehensive view of the user journey by including actions that happen on the server.<br />Typical examples could be checkout.completed or payment.processed.<br /><br />Ingested server-side events are integrated into Product Analytics to allow users to select and filter<br />these events in the event picker, similar to how views or actions are handled.<br /><br />Requirements:<br />- At least one of usr, account, or session must be provided with a valid ID.<br />- The application.id must reference a Product Analytics-enabled application.<br /><br />Custom Attributes:<br />Any additional fields in the payload are flattened and searchable as facets.<br />For example, a payload with {"customer": {"tier": "premium"}} is searchable with<br />the syntax @customer.tier:premium in Datadog.<br /><br />The status codes answered by the HTTP API are:<br />- 202: Accepted: The request has been accepted for processing<br />- 400: Bad request (likely an issue in the payload formatting)<br />- 401: Unauthorized (likely a missing API Key)<br />- 403: Permission issue (likely using an invalid API Key)<br />- 408: Request Timeout, request should be retried after some time<br />- 413: Payload too large (batch is above 5MB uncompressed)<br />- 429: Too Many Requests, request should be retried after some time<br />- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time<br />- 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
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
Lifecycle Methods
EXEC variables use wire (API) names.
- submit_product_analytics_event
Send server-side events to Product Analytics. Server-side events are retained for 15 months.<br /><br />Server-Side events in Product Analytics are helpful for tracking events that occur on the server,<br />as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs.<br />This allows for a more comprehensive view of the user journey by including actions that happen on the server.<br />Typical examples could be checkout.completed or payment.processed.<br /><br />Ingested server-side events are integrated into Product Analytics to allow users to select and filter<br />these events in the event picker, similar to how views or actions are handled.<br /><br />Requirements:<br />- At least one of usr, account, or session must be provided with a valid ID.<br />- The application.id must reference a Product Analytics-enabled application.<br /><br />Custom Attributes:<br />Any additional fields in the payload are flattened and searchable as facets.<br />For example, a payload with {"customer": {"tier": "premium"}} is searchable with<br />the syntax @customer.tier:premium in Datadog.<br /><br />The status codes answered by the HTTP API are:<br />- 202: Accepted: The request has been accepted for processing<br />- 400: Bad request (likely an issue in the payload formatting)<br />- 401: Unauthorized (likely a missing API Key)<br />- 403: Permission issue (likely using an invalid API Key)<br />- 408: Request Timeout, request should be retried after some time<br />- 413: Payload too large (batch is above 5MB uncompressed)<br />- 429: Too Many Requests, request should be retried after some time<br />- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time<br />- 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time
EXEC datadog.digital_experience.product_analytics_events.submit_product_analytics_event
@@json=
'{
"account": "{{ account }}",
"application": "{{ application }}",
"event": "{{ event }}",
"session": "{{ session }}",
"type": "{{ type }}",
"usr": "{{ usr }}"
}'
;