MEmessangi
Segments

Segment information

Changed on

Requires authentication — see Authentication.

Retrieves the information of a certain segment from a list previously created.

get/v3/lists/{listId}/segments/{segmentId}

Request

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

Path parameters

listIdinteger required

Provide the unique ID of the list

segmentIdstring required

Provide the unique ID of the segment

Response

Successfully retrieved the segment information

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "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