For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/product-analytics/compute-journey-funnel-analysis.md. A documentation index is available at /llms.txt.
homeHomedocsDocsapiAPI
Language
Datadog site

Compute journey funnel analysis

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
POSThttps://api.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.us3.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.us5.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.datadoghq.eu/api/v2/product-analytics/journey/funnelhttps://api.ap1.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.ap2.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.uk1.datadoghq.com/api/v2/product-analytics/journey/funnelhttps://api.ddog-gov.com/api/v2/product-analytics/journey/funnelhttps://api.us2.ddog-gov.com/api/v2/product-analytics/journey/funnel

Overview

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.

This endpoint requires the rum_apps_read permission.

Request

Body Data (required)

Field
Type
Description
data [required]
object

The single JSON:API resource carrying a funnel query. Its attributes hold the time window to query and the journey whose step-to-step conversion should be measured.

Response

OK

Response for a journey funnel analysis.

Field
Type
Description
data [required]
object

The single JSON:API resource holding a computed funnel. Its attributes contain the number of entities that entered, the end-to-end conversion, and one entry per funnel step.

Code Example

Compute journey funnel analysis
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/journey/funnel" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "from": 1756425600000,
      "query": {
        "compute": {
          "aggregation": "count"
        },
        "search": {
          "expression": "A -> B",
          "node_objects": {
            "A": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:view @view.name:Login"
              }
            },
            "B": {
              "data_source": "product_analytics",
              "search": {
                "query": "@type:action @action.target.name:Submit"
              }
            }
          }
        }
      },
      "to": 1756857600000
    },
    "type": "journey_request"
  }
}
EOF