Overview
The Segments API is used for creating, updating, and managing audience segments.
- A segment is a targetable group of users that can be populated from various data sources and used to target line items.
- A segment category groups segments for organizational purposes.
- A segment tag is automatically generated when a segment is created and can be placed on a website to add users to that segment.
Both segments and segment categories can be shared with another account.
Use the Segments API to accomplish the following tasks:
- List, create, retrieve, update, partially update, duplicate, or delete segments
- Bulk create, update, or delete segments
- List, create, retrieve, update, partially update, duplicate, or delete a segment category
- Bulk create, update, or delete segment categories
- List one or many segment tags
- List, create, or retrieve segment uploads from S3 file references
- List, create, update, or partially update a segment category sharing relationship
- Bulk create or update segment category sharing relationships
- List, create, retrieve, update, or partially update a segment sharing relationship
- Bulk create or update a segment sharing relationship
Uniform Resource Identifiers (URI)
| Feature | URI |
|---|---|
| /segment-categories | https://{buzz_key}.api.beeswax.com/rest/v2/segment-categories |
| /segment-tags | https://{buzz_key}.api.beeswax.com/rest/v2/segment-tags |
| /segment-uploads | https://{buzz_key}.api.beeswax.com/rest/v2/segment-uploads |
| /segments | https://{buzz_key}.api.beeswax.com/rest/v2/segments |
| /shared/segment-categories | https://{buzz_key}.api.beeswax.com/rest/v2/shared/segment-categories |
| /shared/segments | https://{buzz_key}.api.beeswax.com/rest/v2/shared/segments |
