Targeting

List Audience Segment Taxonomies

Returns a paginated list of audience segment taxonomies. By default each item contains only the root node of its taxonomy (taxonomy.children is an empty array); pass full=true (or full=1 / full=*) to also return the complete nested segment tree under each root. Results can be filtered with q= and sorted with sort_by=.

Filterable / sortable fields:

Field	Source table
id	audience_segments
taxonomy_id	audience_segments
audience_vendor_id	audience_segments
name	audience_segments
code	audience_segments
buyable	audience_segments
retail_cpm	audience_segments
wholesale_cpm	audience_segments
uniques	audience_segments
visibility	audience_taxonomies

Pagination is at the taxonomy level: page_limit=1 returns one taxonomy (with its complete tree when full is set, potentially many segments). Filtering on segment fields (for example q=name=:*X*) still selects taxonomies that contain a matching segment, regardless of full.

get/audience_taxonomies

Request

Base URL
https://api.mediamath.com/api/v3.0
Auth
OAuth 2
Authorization codehttps://auth.mediamath.com/authorize
Token URLhttps://auth.mediamath.com/oauth/token
Scopesoffline_access, manage:services
TypeScript
https://skmtc.dev/mediamath/apis/campaigns-api/docs/audience_taxonomies/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

page_limitinteger

Example:100

Number of elements in the collection to retrieve

page_offsetinteger

Index of the first element in the collection to retrieve

sort_bystring

Example:id, -id, name, -name

The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.

qstring

Query search for filtering. This parameter can be used to filter results based on various fields. Supported operators:

== - numeric equality or case-sensitive string identity,
==(1,2,3) - IN query (only works for integers),
!= - numeric inequality or case-sensitive string non-identity,
=: - case-insensitive match, allows substring using * wildcards,
!: - case-insensitive non-match ("does not contain"), allows substring using * wildcards; rows where the field is NULL are excluded,
< - less than,
<= - less than or equal to,
> - greater than,
>= - greater than or equal to. Examples:
q=name=:{search}* to find all results with names starting with {search}.
Numeric q=id=:*123* searches are treated as exact primary-key matches, equivalent to q=id==123; likewise q=id!:*123* is equivalent to q=id!=123.
q=name!:*promo* to exclude all results whose name contains "promo".
q=status==true to find all active entities.
q=id>=1000 to find all entities with id greater than or equal to 1000.
q=id==(1,2,3) to find specific entities by ID.
q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
q=id>5&status==true to find all active entities with id greater than 5.

fullstring

Example:*

To return all fields, set the value to *. For example, full=* will include all properties.

Response

Paginated list of audience segment taxonomies

Example response

{
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.