Skip to main content
POST
/
v1
/
customers
/
segments
/
preview
Preview segment customers
curl --request POST \
  --url https://api.hyperline.co/v1/customers/segments/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    {
      "operator": "and",
      "conditions": [
        {
          "field": "country",
          "operator": "in",
          "value": [
            "FR"
          ]
        }
      ]
    }
  ]
}
'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "country": "FR",
      "currency": "EUR",
      "language": "fr",
      "billing_email": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0

Body

application/json
rules
object[]
required
Minimum array length: 1

Response

200 - application/json
meta
object
required
data
object[]
required

List of SegmentPreviewCustomer.