Segments

Get a website segment or cohort

GET/api/websites/{websiteId}/segments/{segmentId}

Returns a saved segment or cohort and its filter parameters for the website.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.
segmentIdrequired	string	ID of the saved segment or cohort.

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"
}

401Unauthorized.

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

401 example

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

404Not found.

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

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/segments/{segmentId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousCreate a website segment or cohort NextUpdate a website segment or cohort