Search DEM journeys

GET https://api.ap1.datadoghq.com/api/v2/dem/journeys/searchhttps://api.ap2.datadoghq.com/api/v2/dem/journeys/searchhttps://api.datadoghq.eu/api/v2/dem/journeys/searchhttps://api.ddog-gov.com/api/v2/dem/journeys/searchhttps://api.us2.ddog-gov.com/api/v2/dem/journeys/searchhttps://api.uk1.datadoghq.com/api/v2/dem/journeys/searchhttps://api.datadoghq.com/api/v2/dem/journeys/searchhttps://api.us3.datadoghq.com/api/v2/dem/journeys/searchhttps://api.us5.datadoghq.com/api/v2/dem/journeys/search

Overview

Search for DEM journeys with optional filtering by query, creator, team, and app. This endpoint requires the synthetics_read permission.

Arguments

Query Strings

Name

Type

Description

query

string

A search query string to filter journeys by name.

page[offset]

integer

The offset for pagination.

page[limit]

integer

The maximum number of results to return.

creator

string

Filter journeys by creator handle.

team

string

Filter journeys by team tag.

app_id

string

Filter journeys by application ID.

Response

OK

Response body for a list of DEM journeys.

Expand All

Field

Type

Description

data [required]

[object]

List of DEM journey data objects.

attributes [required]

object

Attributes returned in a DEM journey response.

created_at [required]

date-time

The timestamp when the journey was created.

created_by [required]

object

A Datadog user associated with a DEM operation.

email [required]

string

The email address of the user.

handle [required]

string

The handle of the user.

name [required]

string

The display name of the user.

uuid [required]

string

The UUID of the user.

description [required]

string

An optional human-readable description of the journey.

journey_rum [required]

object

The RUM definition for a DEM journey.

filter

string

An optional RUM query filter applied to the entire journey.

rum_steps [required]

[object]

List of RUM journey steps.

nodes [required]

[object]

List of RUM nodes within a journey step.

app_id

string

The application ID associated with this node.

id

string

The ID of the RUM node element.

query [required]

string

The RUM query for matching this node.

type [required]

enum

The type of a RUM journey step. Allowed enum values: start,stop,step

variants

[object]

List of variants associated with a DEM journey.

filter

string

An optional RUM query filter to scope this variant.

id

string

The unique identifier of the variant.

name [required]

string

The name of the variant.

rum_steps [required]

[object]

List of RUM journey steps.

nodes [required]

[object]

List of RUM nodes within a journey step.

app_id

string

The application ID associated with this node.

id

string

The ID of the RUM node element.

query [required]

string

The RUM query for matching this node.

type [required]

enum

The type of a RUM journey step. Allowed enum values: start,stop,step

name [required]

string

The name of the DEM journey.

org_id [required]

int64

The organization ID that owns this journey.

tags [required]

[string]

List of tags associated with a DEM resource.

test_suite [required]

object

A test suite associated with a DEM resource.

id [required]

string

The ID of the test suite.

name [required]

string

The name of the test suite.

updated_at [required]

date-time

The timestamp when the journey was last updated.

updated_by [required]

object

A Datadog user associated with a DEM operation.

email [required]

string

The email address of the user.

handle [required]

string

The handle of the user.

name [required]

string

The display name of the user.

uuid [required]

string

The UUID of the user.

variants [required]

[object]

List of variants associated with a DEM journey.

filter

string

An optional RUM query filter to scope this variant.

id

string

The unique identifier of the variant.

name [required]

string

The name of the variant.

rum_steps [required]

[object]

List of RUM journey steps.

nodes [required]

[object]

List of RUM nodes within a journey step.

app_id

string

The application ID associated with this node.

id

string

The ID of the RUM node element.

query [required]

string

The RUM query for matching this node.

type [required]

enum

The type of a RUM journey step. Allowed enum values: start,stop,step

id [required]

string

The unique identifier of the DEM journey.

type [required]

enum

The type identifier for DEM journeys. Allowed enum values: journeys

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "created_by": {
          "email": "jane.doe@example.com",
          "handle": "jane.doe",
          "name": "Jane Doe",
          "uuid": "00000000-0000-0000-0000-000000000001"
        },
        "description": "Tracks the user checkout flow from cart to confirmation.",
        "journey_rum": {
          "filter": "env:prod",
          "rum_steps": [
            {
              "nodes": [
                {
                  "app_id": "app-xyz789",
                  "id": "element-id-123",
                  "query": "action.name:'checkout'"
                }
              ],
              "type": "start"
            }
          ],
          "variants": [
            {
              "filter": "device.type:mobile",
              "id": "variant-001",
              "name": "Mobile checkout",
              "rum_steps": [
                {
                  "nodes": [
                    {
                      "app_id": "app-xyz789",
                      "id": "element-id-123",
                      "query": "action.name:'checkout'"
                    }
                  ],
                  "type": "start"
                }
              ]
            }
          ]
        },
        "name": "Checkout Flow",
        "org_id": 12345,
        "tags": [
          "team:synthetics",
          "env:prod"
        ],
        "test_suite": {
          "id": "suite-abc123",
          "name": "My Journey Suite"
        },
        "updated_at": "2024-01-16T08:00:00Z",
        "updated_by": {
          "email": "jane.doe@example.com",
          "handle": "jane.doe",
          "name": "Jane Doe",
          "uuid": "00000000-0000-0000-0000-000000000001"
        },
        "variants": [
          {
            "filter": "device.type:mobile",
            "id": "variant-001",
            "name": "Mobile checkout",
            "rum_steps": [
              {
                "nodes": [
                  {
                    "app_id": "app-xyz789",
                    "id": "element-id-123",
                    "query": "action.name:'checkout'"
                  }
                ],
                "type": "start"
              }
            ]
          }
        ]
      },
      "id": "journey-abc123",
      "type": "journeys"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dem/journeys/search" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}"
"""
Search DEM journeys returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dem_api import DEMApi

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = DEMApi(api_client)
    response = api_instance.search_journeys()

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# Search DEM journeys returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::DEMAPI.new
p api_instance.search_journeys()

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// Search DEM journeys returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewDEMApi(apiClient)
	resp, r, err := api.SearchJourneys(ctx, *datadogV2.NewSearchJourneysOptionalParameters())

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DEMApi.SearchJourneys`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DEMApi.SearchJourneys`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// Search DEM journeys returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DemApi;
import com.datadog.api.client.v2.model.DemJourneysListResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    DemApi apiInstance = new DemApi(defaultClient);

    try {
      DemJourneysListResponse result = apiInstance.searchJourneys();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DemApi#searchJourneys");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
// Search DEM journeys returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dem::SearchJourneysOptionalParams;
use datadog_api_client::datadogV2::api_dem::DEMAPI;

#[tokio::main]
async fn main() {
    let configuration = datadog::Configuration::new();
    let api = DEMAPI::with_config(configuration);
    let resp = api
        .search_journeys(SearchJourneysOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Search DEM journeys returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.DEMApi(configuration);

apiInstance
  .searchJourneys()
  .then((data: v2.DemJourneysListResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"