Segments
Learn about the Data Marketplace Buyer API segment endpoints.
A segment is a group of third-party consumer records defined by a specific set of attributes.
You can use the Data Marketplace Buyer API to:
- Display a list of Data Marketplace segments and their associated metadata.
- Display additional segment details for a particular segment.
- Update your list of Data Marketplace segments with the most current information, including segments that have been removed from the Data Marketplace or segments whose metadata has changed.
- Enable Data Marketplace segments for use in the Activation API.
Buyer API Endpoints
Use the Data Marketplace Buyer API segment endpoints to display the following:
Segment Endpoint | Description |
---|---|
/v3/segments | Get a list of Data Marketplace segments and their associated metadata. |
/v3/segments/{v3SegmentsId}/id | Get additional details for a particular segment. |
/v3/segment-updates | Get a list of updated Data Marketplace segments with the most current information, including segments that have been removed from the Data Marketplace or segments whose metadata has changed. |
/v3/requested-segments | Enable Data Marketplace segments for distribution by the Activation API. |
Filtering Segments
Use filters to make sure you retrieve only the Data Marketplace segments relevant to your needs. You can filter by the following:
- Advertiser name (to display only segments not blocked from that advertiser)
- Data provider name
- Country
- Currency
- Identifier type (cookie, mobile, CID, identity link, or offline
- Fully or partially refreshed since a specified date
- Whether reach expansion has been enabled
You can combine as many filters as you like. You can include multiple possible values for a single filter when this is indicated in the parameter reference below. Within a parameter, the logical operator is OR
. Between different parameters, the logical operator is AND
.
For example, suppose you want segments with price type CPM or CPC, ID type cookie or MAID, and reach extension disabled. This translates to segments which meet the following criteria:
(Price type = CPM OR CPC) AND (ID type = cookie OR MAID) AND (reach extension = false)
Refreshing Data
Examples
Get only segments targeted in the US
curl --request GET \
--url 'https://api.liveramp.com/data-marketplace/buyer-api/v3/segments?limit=1000&countryCodes=USA¤cyCodes=USD' \
--header 'accept: application/json'
Get only segments targeted in the US and refreshed in the last seven days
curl --request GET \
--url 'https://api.liveramp.com/data-marketplace/buyer-api/v3/segments?limit=1000&lastPartialRefreshAfter=20230925%2000%3A00%3A00.00&countryCodes=USA¤cyCodes=USD' \
--header 'accept: application/json'
Get only segments eligible for TV
Segments can be filtered by the following specifications to ensure they are eligible for TV:
- Reach extension is disabled
- Has had a full refresh within the last 180 days (or other time period)
- Has had a partial refresh within the last 180 days (or other time period)
- Identifier type (Cookie, Mobile, CID, identity link, or offline)
Updated 12 months ago