For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/product-analytics/compute-journey-scalar-analytics.md. A documentation index is available at /llms.txt.
homeHomedocsDocsapiAPI
Language
Datadog site

Compute journey scalar analytics

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/scalarhttps://api.us3.datadoghq.com/api/v2/product-analytics/journey/scalarhttps://api.us5.datadoghq.com/api/v2/product-analytics/journey/scalarhttps://api.datadoghq.eu/api/v2/product-analytics/journey/scalarhttps://api.ap1.datadoghq.com/api/v2/product-analytics/journey/scalarhttps://api.ap2.datadoghq.com/api/v2/product-analytics/journey/scalarhttps://api.uk1.datadoghq.com/api/v2/product-analytics/journey/scalarhttps://api.ddog-gov.com/api/v2/product-analytics/journey/scalarhttps://api.us2.ddog-gov.com/api/v2/product-analytics/journey/scalar

Overview

Compute scalar results for a journey query, such as the conversion count, the conversion rate, or the time to convert, 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 journey scalar query. Its attributes hold the time window and the journey metric to reduce to one value over that window.

Response

OK

Response for a journey scalar query.

Field
Type
Description
data [required]
object

The single JSON:API resource holding journey scalar results. Its attributes contain one value per group, suitable for a query value or top list widget.

Code Example

Compute journey scalar analytics
# 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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_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/scalar" \
-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",
          "metric": "__dd.conversion_rate"
        },
        "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": "formula_journey_request"
  }
}
EOF