FAfabric
Segment

Get list of all segments

Retrieves a paginated list of segments based on query parameters.

get/api-offers/segment/list

Request

Query parameters

limitnumber

The maximum number of records per page.

offsetnumber

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Response

OK

Example response

{
  "query": {
    "limit": 10,
    "count": 150
  },
  "data": [
    {
      "_id": "614b58924e92f6861ac9d43b",
      "segmentId": 100002,
      "name": "Customer Type",
      "value": [
        "High Spender"
      ],
      "createdAt": "2020-12-14T12:15:43.646Z",
      "updatedAt": "2021-12-14T12:15:43.646Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.