MEmessangi
Segments

List segments

Changed on

Requires authentication — see Authentication.

This endpoint helps you return a list of all segments from a list previously created. Extra filters can be added using segment's information (e.g. segmentType=STATIC).

get/v3/lists/{listId}/segments

Request

  • Base URL
    https://elastic.messangi.me/qarth
  • URL
    https://elastic.messangi.me/qarth/v3/lists/{listId}/segments
  • Auth
    HTTP bearer

Path parameters

listIdinteger required

Provide the unique ID of the list

Response

Successfully retrieved the segments

totalinteger

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "people who likes movies",
      "userName": "homer",
      "listId": 203,
      "queryRule": "movies[eq]=horror&age[gt]=21",
      "total": 7
    }
  ]
}

Changes

  • 47d573a56b26Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status