Segments

Create a website segment or cohort

POST/api/websites/{websiteId}/segments

Saves a named segment or cohort with its type and filter parameters for the website.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Request body

Name	Type	Description
namerequired	string	Display name of the resource.
parametersrequired	object	Configuration parameters for the resource.

typerequired	enum<string>	Options: `segment`, `cohort`

Example request

{
  "name": "string",
  "parameters": {
    "action": {
      "type": "string",
      "value": "string"
    },
    "dateRange": "string",
    "filters": [],
    "match": "all"
  },
  "type": "segment"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

typerequired	string
updatedAtrequired	string	Date and time the record was last updated.
websiteIdrequired	string	ID of the website.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "type": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "websiteId": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/websites/{websiteId}/segments' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "parameters": {
    "action": {
      "type": "string",
      "value": "string"
    },
    "dateRange": "string",
    "filters": [],
    "match": "all"
  },
  "type": "segment"
}'

PreviousList website segments and cohorts NextGet a website segment or cohort