Create Audience Segment Taxonomy

Request

Creates a new audience segment taxonomy with nested hierarchical structure. Access is scoped to the vendor's owning organization; visibility=GLOBAL and revenue_share_pct may be set only by global admins.

Security

Auth0(Required scopes: offline_accessmanage:services)

Bodyapplication/jsonrequired

vendor_idinteger, (int32), >= 1required

ID of the vendor owning this audience segment taxonomy

visibilitystring

Visibility scope of the audience segment

Enum:"GLOBAL""RESTRICTED"

use_hashboolean

Whether to use hashed identifiers for this segment

Default:false

revenue_share_pctnumber, (double), [ 0 .. 100 ]

Revenue share percentage for this segment

is_clearing_houseboolean

Whether this segment is managed through a clearing house

Default:false

permissionsobject

Access permissions scoped to specific entities

taxonomyobject(AudienceTaxonomiesNode)required

Root node of the hierarchical taxonomy tree

POST

/audience_taxonomies

curl -i -X POST \
  https://api.mediamath.com/api/v3.0/audience_taxonomies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "vendor_id": 1,
    "visibility": "GLOBAL",
    "use_hash": false,
    "revenue_share_pct": 100,
    "is_clearing_house": false,
    "permissions": {
      "organizations": [
        1
      ],
      "agencies": [
        1
      ],
      "advertisers": [
        1
      ]
    },
    "taxonomy": {
      "name": "string",
      "description": "string",
      "code": "string",
      "buyable": false,
      "retail_cpm": 0.1,
      "wholesale_cpm": 0.1,
      "uniques": 0,
      "children": [
        {}
      ]
    }
  }'

Responses

Audience segment taxonomy created successfully

Bodyapplication/json

dataobject(AudienceTaxonomiesCreateResponse)

metaobject

Response

{
  "data": {
    "taxonomy_id": 0,
    "audience_vendor_id": 0,
    "revenue_share_pct": 0.1,
    "permissions": { … },
    "taxonomy": { … }
  },
  "meta": {
    "status": "string"
  }
}