API docs by Redocly

Vistar Media SSP API (Beta)

Download OpenAPI specification:

The Vistar Media SSP API enables developers to programmatically interact with Vistar's Ad Platform outside of the web application. Itn enables Media Owners to build system integrations and automations.

Note: This API is in beta and may undergo breaking changes.

For authentication, rate limiting, and other general usage information, please see our API Basics documentation.

Creatives

The Creative resource represents a specific creative provided by a buyer that targets one of your Networks.

Your approval status of the Creative is in the audit object within the Creative.

The API allows you to list and retrieve Creatives and update their audit values.

Creatives can be categorized using IAB categories and your own custom Tags. The Creative Category and Tag endpoints allow you to discover ids to use when updating Creatives. You can also create new Tags.

You can also access a Creative's assets and associated Campaign information.

List Creative Categories

List all Creative Categories

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "creative_categories": [
    ],
  • "total_size": 1
}

Get Creative Category by ID

Get a Creative Category by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Food & Groceries"
}

List Creatives

List Creatives with their Audits

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name, audit.create_time

asc
boolean
filter
Array of strings

Supported filter fields: advertiser_id, bidder_id, network_id, seat_id, type, archived, status, audit.status

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "creatives": [
    ],
  • "total_size": 1
}

Update Creatives Deprecated

Update many Creatives

Authorizations:
SessionCookie
Request Body schema: application/json
required
Array of objects (api.ssp.v1.Creative)

Responses

Request samples

Content type
application/json
{
  • "creatives": [
    ]
}

Response samples

Content type
application/json
{
  • "creatives": [
    ]
}

Partially Update Creatives

Update many Creatives

Authorizations:
SessionCookie
Request Body schema: application/json
required
Array of objects (api.ssp.v1.Creative)

Responses

Request samples

Content type
application/json
{
  • "creatives": [
    ]
}

Response samples

Content type
application/json
{
  • "creatives": [
    ]
}

Get Creative by ID

Get a Creative and Audit by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "abc123",
  • "audit": {
    },
  • "external_id": "67580557345947516864522a0863640c665f48614674",
  • "network_id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Some-Advertising-Campaign-2025.jpg",
  • "processing_status": "PROCESSING",
  • "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  • "thumbnail_url": "https://transcodes.vistarmedia.com.s3.amazonaws.com/abc123/thumb.png",
  • "duration_ms": 1500,
  • "seat_id": "juIGaOygS0CBBqtmXHamqA",
  • "bidder_id": "juIGaOygS0CBBqtmXHamqA",
  • "max_assets_per_day": 0,
  • "type": "NONE",
  • "update_time": "2025-07-03T21:30:40+00:00",
  • "archived": true
}

Update Creative by ID Deprecated

Update an individual Creative by ID

Authorizations:
SessionCookie
path Parameters
id
required
string
Request Body schema: application/json
required
object (api.ssp.v1.Audit)
external_id
string
network_id
string
name
string
processing_status
string (api.ssp.v1.Creative.CreativeStatus)
Default: "PROCESSING"
Enum: "PROCESSING" "PROCESSED" "FAILED"
advertiser_id
string
thumbnail_url
string
duration_ms
integer <int32>
seat_id
string
bidder_id
string
max_assets_per_day
integer <int32>
type
string (api.ssp.v1.CreativeType)
Default: "NONE"
Enum: "NONE" "DYNAMIC" "SAGE_AND_ARCHER_DYNAMIC" "IMAGE" "VIDEO" "AUDIO" "UNKNOWN"
update_time
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "audit": {
    },
  • "external_id": "67580557345947516864522a0863640c665f48614674",
  • "network_id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Some-Advertising-Campaign-2025.jpg",
  • "processing_status": "PROCESSING",
  • "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  • "thumbnail_url": "https://transcodes.vistarmedia.com.s3.amazonaws.com/abc123/thumb.png",
  • "duration_ms": 1500,
  • "seat_id": "juIGaOygS0CBBqtmXHamqA",
  • "bidder_id": "juIGaOygS0CBBqtmXHamqA",
  • "max_assets_per_day": 0,
  • "type": "NONE",
  • "update_time": "2025-07-03T21:30:40+00:00",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "abc123",
  • "audit": {
    },
  • "external_id": "67580557345947516864522a0863640c665f48614674",
  • "network_id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Some-Advertising-Campaign-2025.jpg",
  • "processing_status": "PROCESSING",
  • "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  • "thumbnail_url": "https://transcodes.vistarmedia.com.s3.amazonaws.com/abc123/thumb.png",
  • "duration_ms": 1500,
  • "seat_id": "juIGaOygS0CBBqtmXHamqA",
  • "bidder_id": "juIGaOygS0CBBqtmXHamqA",
  • "max_assets_per_day": 0,
  • "type": "NONE",
  • "update_time": "2025-07-03T21:30:40+00:00",
  • "archived": true
}

Partially Update Creative by ID

Update an individual Creative by ID

Authorizations:
SessionCookie
path Parameters
id
required
string
Request Body schema: application/json
required
object (api.ssp.v1.Audit)
external_id
string
network_id
string
name
string
processing_status
string (api.ssp.v1.Creative.CreativeStatus)
Default: "PROCESSING"
Enum: "PROCESSING" "PROCESSED" "FAILED"
advertiser_id
string
thumbnail_url
string
duration_ms
integer <int32>
seat_id
string
bidder_id
string
max_assets_per_day
integer <int32>
type
string (api.ssp.v1.CreativeType)
Default: "NONE"
Enum: "NONE" "DYNAMIC" "SAGE_AND_ARCHER_DYNAMIC" "IMAGE" "VIDEO" "AUDIO" "UNKNOWN"
update_time
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "audit": {
    },
  • "external_id": "67580557345947516864522a0863640c665f48614674",
  • "network_id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Some-Advertising-Campaign-2025.jpg",
  • "processing_status": "PROCESSING",
  • "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  • "thumbnail_url": "https://transcodes.vistarmedia.com.s3.amazonaws.com/abc123/thumb.png",
  • "duration_ms": 1500,
  • "seat_id": "juIGaOygS0CBBqtmXHamqA",
  • "bidder_id": "juIGaOygS0CBBqtmXHamqA",
  • "max_assets_per_day": 0,
  • "type": "NONE",
  • "update_time": "2025-07-03T21:30:40+00:00",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": "abc123",
  • "audit": {
    },
  • "external_id": "67580557345947516864522a0863640c665f48614674",
  • "network_id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Some-Advertising-Campaign-2025.jpg",
  • "processing_status": "PROCESSING",
  • "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  • "thumbnail_url": "https://transcodes.vistarmedia.com.s3.amazonaws.com/abc123/thumb.png",
  • "duration_ms": 1500,
  • "seat_id": "juIGaOygS0CBBqtmXHamqA",
  • "bidder_id": "juIGaOygS0CBBqtmXHamqA",
  • "max_assets_per_day": 0,
  • "type": "NONE",
  • "update_time": "2025-07-03T21:30:40+00:00",
  • "archived": true
}

List Creative Assets

Get the Assets for a given Creative ID

Authorizations:
SessionCookie
path Parameters
id
required
string
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string
asc
boolean
filter
Array of strings
search
Array of strings

Responses

Response samples

Content type
application/json
{}

List Creative Campaigns

List Campaign market data for a given Creative ID

Authorizations:
SessionCookie
path Parameters
id
required
string
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: start_date, end_date

asc
boolean
filter
Array of strings
search
Array of strings

Responses

Response samples

Content type
application/json
{
  • "campaigns": [
    ],
  • "total_size": 1
}

List Tags

List all Tags

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "total_size": 1
}

Create Tag

Create a new Tag

Authorizations:
SessionCookie
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "My Test Tag"
}

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "my test tag"
}

Get Tag by ID

Get a Tag by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "my test tag"
}

Advertisers

An Advertiser is a company that runs a campaign.

You can use the Advertiser APIs to resolve the advertiser_id on a Creative to a human-readable name.

List Advertisers

List all Advertisers

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "advertisers": [
    ],
  • "total_size": 1
}

Get Advertiser by ID

Get an Advertiser by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "T-Mobile"
}

Bidders

A Bidder is a DSP where a campaign originated.

You can use the Bidder APIs to resolve the bidder_id on a Creative to a human-readable name.

List Bidders

List all Bidders

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "bidders": [
    ],
  • "total_size": 1
}

Get Bidder by ID

Get a Bidder by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Vistar"
}

Networks

A Network is a Media Owner's venue collection. You can use the Network APIs to list your Networks.

List Networks

List all Networks

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ],
  • "total_size": 1
}

Get Network by ID

Get a Network by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Test Network"
}

Seats

A Seat is buyer of a Campaign.

You can use the Seat APIs to resolve the seat_id on a Creative to a human-readable name.

List Seats

List all Seats

Authorizations:
SessionCookie
query Parameters
page_size
integer <int64>
page
integer <int64>
order
string

Supported order fields: name

asc
boolean
filter
Array of strings

Supported filter fields: id

search
Array of strings

Supported search fields: name

Responses

Response samples

Content type
application/json
{
  • "seats": [
    ],
  • "total_size": 1
}

Get Seat by ID

Get a Seat by ID

Authorizations:
SessionCookie
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "juIGaOygS0CBBqtmXHamqA",
  • "name": "Test User"
}