# Segments

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/segments · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml

Portfolio segments group listings by filter criteria. The `filter_backend` field
is the core of a segment — it defines which listings belong to it.

Use `POST /segments` to create a segment, `PUT /segments/{segment_id}` to update
one, `DELETE /segments/{segment_id}` to delete one, `GET /segments` to list all
segments for the authenticated user,
`GET /segments/{segment_id}/listings` to retrieve the listings matched by a
segment's filter, and `GET /segments/{segment_id}/aggregated_metrics` to fetch
aggregated performance metrics for those listings.

See the `filter_backend_object` schema for a full reference of available filter
keys, operator suffixes, and value formats.

## Endpoints

- [GET /segments](https://docs.usewheelhouse.com/rm/reference/rm-get-segments.md): List portfolio segments.
- [POST /segments](https://docs.usewheelhouse.com/rm/reference/rm-post-segments.md): Create a portfolio segment.
- [PUT /segments/{segment_id}](https://docs.usewheelhouse.com/rm/reference/rm-put-segment.md): Update a portfolio segment.
- [DELETE /segments/{segment_id}](https://docs.usewheelhouse.com/rm/reference/rm-delete-segment.md): Delete a portfolio segment.
- [GET /segments/{segment_id}/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-segment-listings.md): List listings in a segment.
- [GET /segments/{segment_id}/aggregated_metrics](https://docs.usewheelhouse.com/rm/reference/rm-get-segment-aggregated-metrics.md): Get aggregated metrics for a segment.
