Sign in

v3

latestOpenAPI 3.0.02026-07-31162156.9 KB
Journeys

searchJourneys

Search Journeys

post/v1/journey/configuration/search

Request body

qstring

Lucene query syntax See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html

frominteger

The offset of the first result to return. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html

sizeinteger

The maximum number of results to return. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html

sortstring

The sort order. Follows Lucene syntax.

Example request

{
  "q": "_tags:*Flex*",
  "size": 25,
  "sort": "_created_at:desc"
}

Response

Success

hitsnumber

The total number of hits.

Example response

{
  "hits": 1,
  "results": [
    {
      "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",
      "_schema": "journey",
      "_title": "Journey Entity Title",
      "_org": "739224",
      "_created_at": "2020-01-01T00:00:00.000Z",
      "_updated_at": "2020-01-01T00:00:00.000Z",
      "_tags": [
        "Flex"
      ],
      "_manifest": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "journey_name": "Journey Name",
      "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",
      "journey_type": "Sales template",
      "design": "Design EPILOT",
      "created_by": [
        {
          "id": "12345"
        }
      ]
    }
  ]
}