/segments/upload
Allows you to upload a list of segments from a DMP into Adnuntius.
A list of segments can uploaded using a
POST
request.POST https://api.adnuntius.com/api/v1/segments/upload?context=<context>
[
{
"segmentId": "qwerty12345",
"name": "Sports",
"description": "Interested in sports",
"dataSource": "ADNUNTIUS",
"state": "ACTIVE"
},
{
"segmentId": "zxcvbn98765",
"name": "Movies",
"description": "Interested in movies",
"dataSource": "ADNUNTIUS",
"team": "my_team_id",
"state": "ACTIVE"
},
{
"segmentId": "355hd46dh",
"name": "Food",
"description": "Eats food",
"dataSource": "ADNUNTIUS",
"teams": ["team1_id", "team2_id"],
"state": "ACTIVE"
},
{
"segmentId": "355hd46dh",
"name": "Food",
"description": "Eats food",
"dataSource": "ADNUNTIUS",
"teams": ["team1_id", "team2_id"],
"state": "ACTIVE",
"ttlNumber": 100,
"ttlSpec": true,
"timeToLiveType": "FIXED_DURATION",
"ttlUnit": "Days"
}
]
Name | Restriction | Description |
---|---|---|
segmentId | String | Identification of the segment. |
team | String | (optional) Restrict visibility of the segment to this team only |
teams | String[] | (optional) Restrict visibility of the segment to the set of teams only |
name | String | The name of the segment |
description | String | Description for the segment |
dataSource | ADNUNTIUS, ADOBE, CXENSE, LYTICS, RELAY42, PERMUTIVE | The DMP providing the segmentation. |
state | ACTIVE (default), INACTIVE, ARCHIVED | The state of the segment. |
timeToLiveType | FIXED_DURATION, TODAY, THIS_WEEK, THIS_MONTH, UNTIL_MONDAY, UNTIL_TUESDAY, UNTIL_WEDNESDAY, UNTIL_THURSDAY, UNTIL_FRIDAY, UNTIL_SATURDAY, UNTIL_SUNDAY | Defines the time frame you wish to have the segments TTL. |
ttlNumber | Number | The number of ttlUnits to live for. |
ttlUnits | Minutes, Hours, Days | The type of ttlNumbers to show. Can only be used if timeToLiveType is set to "FIXED_DURATION" |
ttlSpec | boolean | Sets the TTL function on or off. |
Last modified 10mo ago