细分

列出网站细分和群组

GET/api/websites/{websiteId}/segments

返回网站已保存的细分或群组，并按请求类型和搜索文本筛选。

Headers

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

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Query parameters

Name	Type	Description
typerequired	enum<string>	Type of resource or analytics dimension to return. Options: `segment`, `cohort`
search	string	Search text used to filter results.

Responses

200The operation completed successfully.

Name	Type	Description
countrequired	number	Number of matching records.
datarequired	object[]	Data returned by the operation.

isCapped	boolean	Whether the results were truncated by the maximum result limit.
orderBy	string	Field to sort the results by.
pagerequired	number	Page number, starting at 1.
pageSizerequired	number	Number of results per page.
search	string	Search text used to filter results.
sortDescending	boolean	Whether to sort results in descending order.

200 example

{
  "count": 0,
  "data": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "name": "string",
      "parameters": "string",
      "type": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "websiteId": "string"
    }
  ],
  "isCapped": true,
  "orderBy": "string",
  "page": 0,
  "pageSize": 0,
  "search": "string",
  "sortDescending": true
}

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 GET 'https://api.example.com/api/websites/{websiteId}/segments?type=segment' \
  -H 'Authorization: Bearer <token>'

Previous获取安装遥测脚本 Next创建网站细分或群组