Segments
Retrieve the list of predefined and custom segments available in your Adobe Analytics account, including shared and curated segments.
View-Specific Information
SELECT
The Segments view supports only a subset of columns for server-side filtering. Below is a table containing those columns with their supported operators.| Column | Supported Operators |
| Id | =, IN |
| Name | =, CONTAINS, LIKE |
| Type | = |
| TagNames | = |
| FilterByPublishedSegments | = |
The LIKE operator is pushed to the server only for substring patterns of the form '%...%'. Other patterns are evaluated client-side.
The IN operator on the Id column is sent as a single batched request using the Adobe Analytics API's segmentFilter parameter.
For example, the following queries are processed server-side:
SELECT * FROM Segments WHERE Id = 's300012345_1234567890'
SELECT * FROM Segments WHERE Name CONTAINS 'Mobile' AND Type = 'all'
SELECT * FROM Segments WHERE Name LIKE '%Customer%'
SELECT * FROM Segments WHERE Id IN ('s300012345_1234567890', 's300012345_0987654321')
Columns
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | Unique identifier of the segment. | ||||
| Name | String | The name of the segment. | ||||
| ReportSuiteName | String | The name of the report suite the segment was created in. | ||||
| Description | String | A description for the segment. | ||||
| Created | Datetime | The datetime the segment was created. | ||||
| Modified | Datetime | The datetime the segment was last modified. | ||||
| OwnerId | String | The unique identifier of the user that created the segment. | ||||
| OwnerName | String | The name of the user that created the segment. | ||||
| Version | String | The version of the segment. | ||||
| Type | String | A comma-separated list of segment types. Allowed values are: shared,templates,curatedItem . | ||||
| SiteTitle | String | The title of the site. | ||||
| TagNames | String | A comma-separated list of tag names. Only segments with all specified tags are returned. | ||||
| FilterByPublishedSegments | String | Filter by published segments. Set to 'all' to include published segments. |