---
title: "List Path Audience Segments"
method: GET
path: "/path_audience_segments"
tags: ["Targeting"]
---

# List Path Audience Segments

`GET /path_audience_segments`

## Request

- Base URL: `https://api.mediamath.com/api/v3.0`
- URL: `https://api.mediamath.com/api/v3.0/path_audience_segments`
- Auth: OAuth 2
  - Authorization code: `https://auth.mediamath.com/authorize`
  - Token URL: `https://auth.mediamath.com/oauth/token` scopes: `offline_access`, `manage:services`
- TypeScript: <https://skmtc.dev/mediamath/apis/campaigns-api/docs/path_audience_segments/get.ts> (a function with typed inputs; its response is checked against the schema)

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`.

## Query parameters

- `page_limit` integer
- `page_offset` integer
- `sort_by` string
- `q` string, required
- `currency_code` string
- `advertiser_id` integer
- `only_brain_enabled` boolean
- `parent_id` integer
- `with` 'audience_vendor'

## Response `200`

Path audience segments collection response

- PathAudienceSegmentsCollectionFull
  - `data` PathAudienceSegment[]
    - `id` integer
    - `name` string
    - `version` integer
    - `parent_audience_segment_id` integer, nullable
    - `full_path` string
    - `uniques` integer
    - `retail_cpm` Cpm[]
      - `currency_code` string
      - `value` number, double
    - `audience_vendor_id` integer
    - `code` string, nullable
    - `buyable` boolean
    - `child_count` integer
    - `wholesale_cpm` Cpm[]
      - `currency_code` string
      - `value` number, double
    - `type` string
    - `taxonomy_id` integer
    - `created_on` string, date-time
    - `updated_on` string, date-time
    - `audience_vendor` AudienceVendor
      - `id` integer
      - `name` string
      - `version` integer
      - `vendor_id` integer
      - `mma_free_cm` boolean
      - `created_on` string, date-time
      - `updated_on` string, date-time
      - `provides_batch_segments` boolean
      - `campaign_brain_enabled` boolean
      - `pin_top_search` boolean
      - `bidder_code` string
      - `namespace_code` string
  - `meta` ListMetadata
    - `status` string, required: The status of the response, indicating success or failure.
    - `count` integer, required: The number of items returned in the current response.
    - `total_count` integer: The total number of items available in the dataset.
    - `offset` integer: The offset from the start of the dataset, used for pagination.
    - `next_page` string: The URL to fetch the next page of results.
    - `prev_page` string: The URL to fetch the previous page of results.

## Other responses

- `400`: Error response
- `401`: Error response
- `403`: Error response
- `404`: Error response

---

[API](https://skmtc.dev/mediamath/apis/campaigns-api.md) - [All operations](https://skmtc.dev/mediamath/apis/campaigns-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mediamath/apis/campaigns-api/revisions/408743891def?raw)