To create a segment in a segment group, use the POST method
https://dmpapi.admixer.net/AudienceAPI/Segment
In the GET request, use the following parameters:
| Parameter | Description | Comment |
|---|---|---|
| name | Segment name unique within a segment group | Maximum number of characters – 256 |
| groupId | ID of a segment group in which you create the segment | |
| idType | Type of user IDs in the segment |
For example,
https://dmpapi.admixer.net/AudienceAPI/Segment?name=NewSegment&groupId=1234&idType=6
where
| NewSegment | name of a new segment |
| 1234 | ID of a segment group in which you create the segment |
| 6 | type of user IDs in the segment (PubID here) |
Types of User IDs
| Type | Value |
|---|---|
| Cookie | 0 |
| IDFA | 1 |
| PubID | 6 |
| AAID | 7 |
| ClientId | 8 |
| 9 | |
| Phone | 10 |
| EmailMD5 | 12 |
| EmailSHA256 | 13 |
| PhoneMD5 | 14 |
| PhoneSHA256 | 15 |
| MultiID | 11 |
In response, you get JSON with a newly created segment’s ID and a message about successful completion.
- Expand an example of a JSON response with a newly created segment’s ID
If you want a list of all current segments, use the POST method
https://dmpapi.admixer.net/AudienceAPI/Segments
- Expand an example of the JSON response with all current segments
where
| groupId | segment group ID |
|---|---|
| groupName | segment group name |
| groupCpmPrice | its CPM in provider currency |
| id | segment ID |
| name | segment name |
| idType | type of ID in the segment |
| userIds | number of unique user IDs in the segment |
To get a list of segments from one or several segment groups, enter the group or groups IDs as an array in the GET request. For example,
https://dmpapi.admixer.net/AudienceAPI/Segments?groupIds=[‘1234’] (from one segment group)
https://dmpapi.admixer.net/AudienceAPI/Segments?groupIds=[‘1234’, ‘1235’] (from several segment groups)
- Expand an example of a JSON response with the list of segments from one or several segment groups