Skip to content
Pevey Docs

List Segments

GET
/admin/analytics/segments
 
curl --request GET \
  --url 'http://localhost:9000/admin/analytics/segments?limit=50&offset=0'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50
offset
integer
0
order
string
fields
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
segments
Array<object>
object
id
string
name
string
label
string
description
string
rules
string
sales_channel_id
string
created_by
string
created_at
string format: date-time
updated_at
string format: date-time
count
integer
limit
integer
offset
integer
Example generated
{
  "segments": [
    {
      "id": "example",
      "name": "example",
      "label": "example",
      "description": "example",
      "rules": "example",
      "sales_channel_id": "example",
      "created_by": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ],
  "count": 1,
  "limit": 1,
  "offset": 1
}