Segments can be created, edited, deleted and viewed using the following REST api instructions. When you have created a segment, you can attach that list to a demand or supply tag for targeting.
Creating a Segment
POST /api/v0/segments
Headers
Content-Type application/json Authorization "yourAuthToken"
Body (example)
Device ID Segment
{ "name": "My , "description": "My Device description", "segment_type”: "list", "segment_list_type”: "device_id" } |
Cookie ID Segment
|
Required parameters: name, description will default to cookie type list unless specified:
“segment_type”: “list”,
”segment_list_type”: “device_id”
Full options:
segment_type (list or pixel)
segment_list_type (cookie or device_id) – only applies when segment_type is list
segment_pixel_type (cookie or ip) – only applies when segment_type is pixel
Response
Status code 200
{
"id": 10044,
"account_id": 1,
"name": "My DID Segment",
"description": "My description",
"active": true,
"segment_type": "list",
"segment_list_type": "cookie",
"created_at": "2020-03-18T19:17:01.383Z"
}
Get a segment
GET /api/v0/segments/<id>
Headers
Content-Type application/json Authorization "yourAuthToken"
Response
Status code 200
{
"id": 10044,
"account_id": 1,
"name": "My DID Segment",
"description": "My description",
"active": true,
"segment_type": "list",
"segment_list_type": "cookie",
"created_at": "2020-03-18T19:17:01.383Z"
}
Add a Segment
POST /api/v0/segments/<id>/items/bulk_create
Headers
Content-Type application/json Authorization "yourAuthToken"
Body (example)
{
"items": ["d207654f-6bdd-474e-9734-67b7c3d02d96"]
}
Response
Status code 200
{"created": True}
Add Items to a Segment using a File
REST API
POST /api/v0/segments/<id>/items/file_bulk_create
curl --location --request POST 'https://console.springserve.com/api/v0/segments/<id>/items/file_bulk_create' \ --header 'Content-Type: application/json' \ --header 'Authorization: <yourAuthToken>' \ --form 'csv_file=@"/<filepath>/appending_items_to_segment_list.csv"'
Response
Status code 201
{"created": True}
Replace Entire Segment
REST API
POST /api/v0/app_name_lists/<id>/app_names/bulk_replace
Headers
Content-Type application/json Authorization "yourAuthToken"
Body (example)
{
"items": ["item1", "item2"]
}
Response
Status code 201
{"created": True}
Replace Entire Segment with a File
Replaces segment with the items in the csv file
REST API
POST /api/v0/segments/<id>/items/file_bulk_replace
curl --location --request POST 'https://console.springserve.com/api/v0/segments/<id>/items/file_bulk_replace' \ --header 'Content-Type: application/json' \ --header 'Authorization: <yourAuthToken>' \ --form 'csv_file=@"/<filepath>/replacement_segment.csv"'
Response
Status code 201
{"created": True}
Get Device IDs or Cookies in a Segment
GET /api/v0/segments/<id>/items
Headers
Content-Type application/json Authorization "yourAuthToken"
Response (note you need to paginate)
Status code 200
[
{
"item": "d207654f-6bdd-474e-9734-67b7c3d02d96"
},
{
"item": "d20gt57i-6bdd-474e-9734-67b7c3d02d96"
}
]
Remove Device Ids or Cookies
DELETE /api/v0/segments/<id>/items/bulk_delete
Headers
Content-Type application/json Authorization "yourAuthToken"
Body (example) where "1" and "2" are the numeric
{
"items": ["d207654f-6bdd-474e-9734-67b7c3d02d96"]
}
Response (note you need to pagenate)
Status code 200
{"deleted": True}
Remove Items using a File
Removes items in the csv file from the segment
REST API
DELETE /api/v0/segments/<id>/items/file_bulk_delete
curl --location --request POST 'https://console.springserve.com/api/v0/segments/<id>/items/file_bulk_delete' \ --header 'Content-Type: application/json' \ --header 'Authorization: <yourAuthToken>' \ --form 'csv_file=@"/<filepath>/delete_these_items.csv"'
Response
Status code 200
{"deleted": True}
Attach to a Demand or Supply Tag
See documentation on the Supply and Demand Tag APIs