product_analytics_retention_grids

Creates, updates, deletes, gets or lists a product_analytics_retention_grids resource.

Overview

Name	product_analytics_retention_grids
Type	Resource
Id	datadog.digital_experience.product_analytics_retention_grids

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
query_product_analytics_retention_grid	insert	data		Compute a retention grid, showing how much of each cohort came back over each subsequent period.<br />Rows are cohorts, columns are return periods, and each cell holds the count and rate of entities that returned.

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.

INSERT examples

query_product_analytics_retention_grid

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

INSERT INTO datadog.digital_experience.product_analytics_retention_grids (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: product_analytics_retention_grids
props:
  - name: data
    description: |
      The single JSON:API resource carrying a retention grid query. Its attributes hold the time
      window to query and the cohort and return criteria that define the grid.
    value:
      attributes:
        exclude_anonymous_traffic: {{ exclude_anonymous_traffic }}
        from: {{ from }}
        query:
          computation_scope:
            target:
              type: "{{ type }}"
              value: {{ value }}
            type: "{{ type }}"
            cohort_target:
              type: "{{ type }}"
              value: {{ value }}
            return_period_target:
              type: "{{ type }}"
              value: {{ value }}
          compute:
            aggregation: "{{ aggregation }}"
            metric: "{{ metric }}"
          group_by:
            - facet: "{{ facet }}"
              limit: {{ limit }}
              should_exclude_missing: {{ should_exclude_missing }}
              sort:
                aggregation: "{{ aggregation }}"
                metric: "{{ metric }}"
                order: "{{ order }}"
              source: "{{ source }}"
              target: "{{ target }}"
          search:
            cohort_criteria:
              base_query: "{{ base_query }}"
              time_interval: "{{ time_interval }}"
            filters:
              audience_filters: "{{ audience_filters }}"
              string_filter: "{{ string_filter }}"
            retention_entity: "{{ retention_entity }}"
            return_condition: "{{ return_condition }}"
            return_criteria:
              base_query: "{{ base_query }}"
              time_interval: "{{ time_interval }}"
        to: {{ to }}
      type: "{{ type }}"