Segments

Estimate Segment

POST
/v0/projects/{idOrSlug}/segments/estimate

Authorization

apiKeyAuth
headerx-api-key<token>

FastStats API key. Pass it in the x-api-key header or as a Bearer token in the Authorization header.

Path Parameters

idOrSlug*string

Request Body

application/json
  1. body
segmentId?string|null|null
type*string
Value in"dynamic""static"
definition*
members*array<>

Response Body

SegmentEstimate

application/json
  1. response
subjects*number|
total*number|
sample*array<>
Example Request
curl -X POST 'https://api.faststats.dev/v0/projects/string/segments/estimate' \  -H 'Content-Type: application/json' \  -d '{  "type": "dynamic",  "definition": {    "type": "group",    "match": "all",    "negate": true,    "children": [      {}    ]  },  "members": [    {      "kind": "identifier",      "value": "string",      "excluded": true    }  ]}'
Example Response
{  "subjects": 0,  "total": 0,  "sample": [    {      "userKey": "string",      "label": "string",      "name": "string",      "email": "string",      "anonymous": true    }  ]}