Get Started with the Media Owner API

The Media Owner API lets you access marketplace data through the SSP (Supply Side Platform) using secure server-to-server requests.. This topic explains how to get started with the Media Owner API.

In this topic, you'll learn:

• How to call the API.
• About access limits.
• About pagination.
• About filtering.
• About searching.
• About sorting.

Review the Setup and Authentication topic and set up authentication. Then you're ready to start calling the API.

The Media Owner API is available in both Staging and Production environments.

Staging: staging-platform-api.vistarmedia.com

Production: platform-api.vistarmedia.com

To ensure system stability and fair usage, this API enforces standard rate limits on all requests. These limits help prevent server overload and protect performance for all users.

Table 1. Access Limits to Prevent Server Overload

If you exceed these limits, the API returns an HTTP 429 error. To avoid errors, build in increasing wait times between retries—especially when automating workflows or running batch operations.

All list operations in the Media Owner API support pagination. Pagination helps you manage large sets of data by returning results in smaller, more manageable chunks.

Use the following query parameters to control pagination:

Table 2. Pagination Parameters and Descriptions

In the API response:

• The returned results appear in a sub-object named after the queried resource (for example, creatives).
• The total_size field provides the total number of matching results.

On the List Advertisers endpoint, this request returns the first 10 results:

GET https://platform-api.vistarmedia.com/api/ssp/v1/advertisers?page_size=10&page=0

{
  "advertisers": [
    {
      "id": "000lYW0SSFSPuV32udyVpA",
      "name": "Nimbus Homeware Co."
    },
    {
      "id": "000_VIH2QaqVN9di7H4AEA",
      "name": "Everpure Essentials"
    },
    {
      "id": "002_g3BbQ50xaom0w8xX5w",
      "name": "Flicker & Bloom"
    },
    {
      "id": "0039nqXKTO0deVpn4M3pPw",
      "name": "Zyra Consumer Labs"
    },
    {
      "id": "003pYILFT6W1wvyQxF10ug",
      "name": "Auric Living Products"
    },
    {
      "id": "00460k62StS3kQrLbtdlaQ",
      "name": "Velvo Household Inc."
    },
    {
      "id": "004FAc_6TiSm_BPgfGNF6A",
      "name": "Plentique Goods"
    },
    {
      "id": "0_08AwjXRfKLOYaqby0pGw",
      "name": "Ravica Solutions"
    },
    {
      "id": "008nP3LgSI6DU3oU96Xneg",
      "name": "Solvanta Home Care"
    },
    {
      "id": "008SCUXpRP6g_SSI8_G5vw",
      "name": "Kinterra Brands"
    }
  ],
  "total_size": 55829
}

Use the filter query parameter to narrow the results returned by most list operations in the Media Owner API. Filtering helps you focus on the data that matters most—such as creatives pending review or associated with specific advertisers.

It’s worth noting:

• Not all fields support filtering. The API Reference specifies which fields you can filter.
• All filters are case-sensitive unless noted otherwise.

Each filter follows this format:

filter=field:<value>

You can apply multiple filters by including the filter parameter more than once in your request. For examples of how to combine filters, see Filter Logic.

The API supports two types of logic when combining filters:

1. AND logic (intersection across different fields). When you use filters for different fields, the result includes only records that match ALL conditions. For example, return creatives that are unapproved and from a specific advertiser:
   GET https://platform-api.vistarmedia.com/api/ssp/v1/creatives?filter=audit.status:pending&filter=advertiser_id:000lYW0SSFSPuV32udyVpA

2. OR logic (union across the same field). When you use multiple filters for the same field, the result includes records that match any of the values. For example, return creatives associated with either of two advertisers:
   GET https://platform-api.vistarmedia.com/api/ssp/v1/creatives?filter=advertiser_id:000lYW0SSFSPuV32udyVpA&filter=advertiser_id:008SCUXpRP6g_SSI8_G5vw

Some Media Owner API list operations support search using the search query parameter. This feature helps you find records by performing substring searches on supported string fields—useful when you don’t have an exact match.

It’s worth noting that not all fields allow searching. The API Reference specifies which fields support search.

Search queries use the following format:

search=field:<value>

Return all advertisers where the name contains the substring “foo”.

https://platform-api.vistarmedia.com/api/ssp/v1/advertisers?search=name:foo

Use the order and asc parameters to sort the results of a list operation. Sorting lets you control the display order of returned records. The order parameter specifies the field to sort on, and asc is a boolean that controls sort direction. Using asc=false applies descending (Z–A) order. Using asc=true applies ascending (A–Z) order. By default, descending order applies when asc isn’t included.

Not all fields allow sorting. You can only sort on fields listed in the API Reference .

Include the following query parameters to sort results:

order=<field>&asc=<true|false>

Return all advertisers sorted by name in descending (Z–A) order.

GET https://platform-api.vistarmedia.com/api/ssp/v1/advertisers?order=name

Return all advertisers sorted by name in ascending (A–Z) order.

GET https://platform-api.vistarmedia.com/api/ssp/v1/advertisers?order=name&asc=true

To learn more about this topic, see:

• Setup and Authentication
• Media Owner API Examples
• Media Owner API Specification