MEmediamath
Targeting

List Path Audience Segments

Get a list of path audience segments. Segments can be queried and sorted by fields:

  • id,
  • name,
  • version,
  • parent_audience_segment_id,
  • full_path,
  • uniques,
  • retail_cpm (type = double, value in usd),
  • code,
  • buyable,
  • child_count,
  • wholesale_cpm (type = double, value in usd),
  • type,
  • taxonomy_id,
  • updated_on,
  • created_on,
  • audience_vendor_id,
  • audience_vendor_name,
  • audience_vendor_vendor_id,
  • audience_vendor_mma_free_cm,
  • audience_vendor_updated_on,
  • audience_vendor_created_on,
  • audience_vendor_version,
  • audience_vendor_provides_batch_segments,
  • audience_vendor_campaign_brain_enabled,
  • audience_vendor_pin_top_search,
  • audience_vendor_bidder_code,
  • audience_vendor_namespace_code.
get/path_audience_segments

Request

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 required

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%26status==true to find all active entities with id greater than 5.
currency_codestring
Example:USD

If not provided, the default currency (USD) will be used.

advertiser_idinteger

Advertiser ID for taxonomy lookup

only_brain_enabledboolean

If true, only segments with audience_vendor.campaign_brain_enabled = true will be returned

parent_idinteger

Parent audience segment ID

with'audience_vendor'

If provided, additional entity information will be returned

Response

Path audience segments collection response

Example response

{
  "data": [
    {
      "retail_cpm": [
        {
          "currency_code": "USD"
        }
      ],
      "wholesale_cpm": [
        {
          "currency_code": "USD"
        }
      ]
    }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100
  }
}

Changes

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