AudiencePush

1 Minute to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Add a new audience or updates an existing audience

Key	Value(s)	Description
method	"AudiencePush"	Add a new audience or updates an existing audience
name	"Audience name"	Audience name - must be unique in project
tags	[ "tag1", "tag2" ]	tags are used to control the display of audiences in the audience builder app
overwrite	true/false	Optional. default = ??. If true, existing audience will be overwritten. If false and audience exists, error message "An audience named 'xxxxxx' already exists" will be returned.
audienceId	"NNNN"	When an audience is pushed for the first time the server will generate a new audience id. This is provided by access server and is an integer.
expiryDate	"DateString"	reserved for future use
clientMeta	{ "clientID": "" "clientAcronym":"" "projectNumber":"" }	extensible metadata

audience is identified by 'name'
an error will be thrown if that audience already exists and 'overwrite' is false
new audiences have a default 'status' of "draft" and 'archiveStatus' "active"
this call cannot be used to change either status

When an audience is pushed for the first time the server will generate a new audience id. This is provided by access server

Returns 'added' : true or errors.

{
  "method": "AudiencePush",
  "project": "eyeota-audience",
  "name": "Over65 or retired Buick owners",
  "audienceId": "1011",
  "description": "My description",
  "tags": [
    "SelectGroups",
    "Sam"
  ],
  "clientMeta": {
    "clientId": "SBM",
    "clientAcronym": "asd",
    "projectNumber": "123"
  },
  "definition": {
    "entries": [
      {
        "logic": "OR",
        "id": "10141",
        "name": "Auto - Owner - Car Make - Buick",
        "records": 45139177
      },
      {
        "logic": "AND",
        "id": "11053",
        "name": "Demo - Employment Status - Retired",
        "records": 129702969
      },
      {
        "logic": "OR",
        "id": "11025",
        "name": "Demo - Age - Declared 65+",
        "records": 115699971
      }
    ]
  },
  "overwrite": true
}

Was this article helpful?

What's Next

AudienceRename