DEM

Search DEM journeys

Search for DEM journeys with optional filtering by query, creator, team, and app.

get/api/v2/dem/journeys/search

Request

Query parameters

querystring

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.

creatorstring

Filter journeys by creator handle.

teamstring

Filter journeys by team tag.

app_idstring

Filter journeys by application ID.

Response

OK

Example response

{
  "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": [
                {
                  "query": "action.name:'checkout'"
                }
              ],
              "type": "start"
            },
            {
              "nodes": [
                {
                  "query": "action.name:'confirmation'"
                }
              ],
              "type": "stop"
            }
          ],
          "variants": [
            {
              "name": "Mobile checkout",
              "rum_steps": [
                {
                  "nodes": [
                    {
                      "query": "action.name:'checkout'"
                    }
                  ],
                  "type": "start"
                },
                {
                  "nodes": [
                    {
                      "query": "action.name:'confirmation'"
                    }
                  ],
                  "type": "stop"
                }
              ]
            }
          ]
        },
        "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": [
          {
            "name": "Mobile checkout",
            "rum_steps": [
              {
                "nodes": [
                  {
                    "query": "action.name:'checkout'"
                  }
                ],
                "type": "start"
              },
              {
                "nodes": [
                  {
                    "query": "action.name:'confirmation'"
                  }
                ],
                "type": "stop"
              }
            ]
          }
        ]
      },
      "id": "journey-abc123",
      "type": "journeys"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.