Segments

Segments

Display a listing of segments in a workspace.

get

Display a listing of segments in a workspace.

Path parameters

workspaceIdstringRequired

ID of the workspace

Query parameters

namestringOptional

Filter segments by name

per_pageintegerOptional

Number of items per page

Default: 15

pageintegerOptional

Page number for pagination

Default: 1

Responses

200

Successful operation

get

api/workspaces/{workspaceId}/segments

HTTPcURLJavaScriptPython

GET api/workspaces/{workspaceId}/segments HTTP/1.1
Host: 
Accept: */*

200

Successful operation

No content

Store a newly created segment

post

Store a newly created segment in storage.

Body

application/json

namestringOptionalExample: Active Users

Responses

201

Segment created successfully

No content

post

/api/workspaces/{workspaceId}/segments

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/segments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "name": "Active Users",
  "rules": [
    {
      "attribute_definition_id": "text",
      "operator": "text",
      "value": "text"
    }
  ]
}

201

Segment created successfully

No content

Update a segment

put

Update the specified segment.

Body

application/json

namestringOptionalExample: Updated Segment Name

Responses

200

Segment updated successfully

400

Validation error

404

Segment not found

put

/api/workspaces/{workspaceId}/segments/{segmentId}

HTTPcURLJavaScriptPython

PUT /api/workspaces/{workspaceId}/segments/{segmentId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "name": "Updated Segment Name",
  "rules": [
    {
      "attribute_definition_id": "text",
      "operator": "text",
      "value": "text"
    }
  ]
}

No content