APIs
Statistical APIs
Audience APIs
Create and edit your audience groups with Audience API.
To create an audience group, use the POST method
https://dmpapi.admixer.net/AudienceAPI/AudienceGroup
In the GET request, use the following parameters:
| Parameter | Description | Comment |
|---|---|---|
| name | Audience group name | Maximum number of characters – 256 |
| advertiserId | ID of an advertiser for which you create an audience group | |
| idType | Type of user IDs in the audience group | |
| dataLifetime (необязательный) | Period of how long the data is stored in the group (number of days) | Value from 1 to 180 |
The parameter dataLifetime is optional. If you don’t use it, the system will automatically set the storage period of 180 days.
For example,
where
| MyAudienceGroup | audience group name |
| 1234 | advertiser ID |
| 1 | type of user IDs |
| 115 | data storage period (115 days) |
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 audience group’s ID and a message about successful completion.
- Expand an example of the JSON response with a newly created audience group’s ID
If you want a list of all active audience groups, use the POST method
https://dmpapi.admixer.net/AudienceAPI/AudienceGroups
- Expand an example of the JSON response with the list of all active audience groups
In the response, you retrieve the following data.
| id | audience group ID |
| name | audience group name |
| advertiserId | ID of the advertiser to which the group belongs |
| idType | type of IDs in the group |
| userIds | number of unique user IDs in the group |
To get a list of audience groups that belong to a particular advertiser, enter the advertiser’s ID in the GET request. For example
https://dmpapi.admixer.net/AudienceAPI/AudienceGroups?advertiserId=12345
where 12345 is an advertiser ID.
- Expand an example of the JSON response with the a list of audience groups that belong to a particular advertiser
The interval between requests must be no less than 30 sec
Updated on April 28, 2023