product_analytics_sankeys

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

Overview

Name	product_analytics_sankeys
Type	Resource
Id	datadog.digital_experience.product_analytics_sankeys

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_sankey	insert	data		Compute a Sankey diagram of how sessions flow between the values of two facets,<br />showing where users continue and where they drop off at each step.

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_sankey

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

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

Manifest

# Description fields are for documentation purposes
- name: product_analytics_sankeys
props:
  - name: data
    description: |
      The single JSON:API resource carrying a Sankey query. Its attributes hold the time window to
      query, the search that selects the sessions, and the definition of the diagram to build.
    value:
      attributes:
        definition:
          entries_per_step: {{ entries_per_step }}
          number_of_steps: {{ number_of_steps }}
          source: "{{ source }}"
          target: "{{ target }}"
        search:
          audience_filters:
            accounts:
              - name: "{{ name }}"
                query: "{{ query }}"
            formula: "{{ formula }}"
            segments:
              - name: "{{ name }}"
                segment_id: "{{ segment_id }}"
            users:
              - name: "{{ name }}"
                query: "{{ query }}"
          join_keys:
            primary: "{{ primary }}"
            secondary:
              - "{{ secondary }}"
          query: "{{ query }}"
        time:
          from: {{ from }}
          to: {{ to }}
      type: "{{ type }}"