Persona

?cuid=<customer ID> query string parameter is needed for all Personas endpoints below.

POST /campaign/:cid/persona

* Denotes optional parameter

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
    name: STRING,
    geo: {
       geos: [STRING ("CA"), STRING ("CA-ON"), STRING ("CA-ON-Toronto"), ...]
       OR
       radius: INT (meters), geocode: [FLOAT (Lat), FLOAT (Long)]
    },
    *cat: [ STRING (IAB1), STRING (IAB20), ... ],
    device: { mobile: BOOL, tablet: BOOL, desktop: BOOL },
    *demo: {
      gender: { male: BOOL, female: BOOL, unknown: BOOL } OR null
      age: { "13to17": true, "18to34": true, "35to49": true, "50+": true} or null
    }
}

Create a new persona for the given campaign

cat must be a valid IAB category of format IAB# or IAB#-# for sub-categories. These will greatly limit the targetting scope to be cautious

geo can include either a list of geos: [] or a single radius: INT (meters), geocode: [FLOAT (Lat), FLOAT (Long)].One or the other must be supplied. geos must be of the form ‘[Country Shortcode]-[State/Province Shortcode]-[City Name], with variations allowed for whole countries eg: ‘CA’ or ‘US’ or whole provinces/states *eg: ‘CA-ON, CA-QC, US-FL’.

Startdate and Enddate will be inherited from the campaign

Response will include {pid: [PERSONA ID]} to be used in future API calls

GET /campaign/:cid/persona

Get the list of personas belonging to a campaign.

GET /campaign/:cid/persona/:pid

Get a specific persona belonging to a campaign

PUT /campaign/:cid/persona/:pid

* Denotes optional parameter

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
    *name: STRING,
    *geo: {
       geos: [STRING ("CA"), STRING ("CA-ON"), STRING ("CA-ON-Toronto"), ...]
       OR
       radius: INT (meters), geocode: [FLOAT (Lat), FLOAT (Long)]
    },
    *cat: [ STRING (IAB1), STRING (IAB20), ... ],
    *device: { mobile: BOOL, tablet: BOOL, desktop: BOOL },
    *demo: {
      gender: { male: BOOL, female: BOOL, unknown: BOOL } OR null
      age: { "13to17": true, "18to34": true, "35to49": true, "50+": true} or null
    }
}

Consult the `POST /campaign/:cid**/persona` for field information

Edit a persona. Only supplied fields are edited. $set behaviour

PUT /campaign/:cid/persona/:pid/pause

Pause the given persona

PUT /campaign/:cid/persona/:pid/resume

Resume the given persona

DELETE /campaign/:cid/persona/:pid

Removes the persona from API access.