Skip to main content
GET
/
api
/
v1
/
segments
/
{segmentKey}
/
preview
Preview segment
curl --request GET \
  --url http://localhost:3001/api/v1/segments/{segmentKey}/preview \
  --header 'x-api-key: <api-key>'
{
  "matchedUserCount": 4503599627370495,
  "previewedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

​
segmentKey
string
required

Stable developer key for the Segment.

Required string length: 1 - 120

Response

Default Response

​
matchedUserCount
integer
required
Required range: 0 <= x <= 9007199254740991
​
previewedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$