Insertion Orders

Marketplace DSP API

Insertion Orders

Insertion orders represent a contractual agreement between the buyer and the media owner. Each insertion order is associated with a single advertiser and contains one or more campaigns (line items). These campaigns divide the insertion order budget and define targeting and other business rules. Using this API, you can list, view, create, and update insertion orders.

Operations

List Insertion Orders

Request

Returns a list of the seat’s insertion orders, optionally with progress information.

Security

SessionCookie

Query

page_sizeinteger, (int64)

The maximum number of results to return per page.

pageinteger, (int64)

The zero-based page offset (page number ) to return. For example, 0 returns the first page, 1 returns the second page, and so on.

orderstring

The field to sort the results by.

ascboolean

Specifies the sort direction. Set to true for ascending order or false for descending order.

filterArray of strings

The field to filter by. You can specify multiple filter parameters.

When you apply filters to different fields, the results include only records that match all specified field values (AND logic). When you apply multiple filters to the same field, the results include records that match any of the specified values in that field (OR logic).

Supported Fields: id, archived, insertion_order_id, region_code, active, pacing, buy_type

Special Filters: in_flight: When true, limits results to insertion orders where the current time falls between start_time and end_time.

Example:filter=in_flight:true

searchArray of strings

Performs a substring search on a specified field. The search is case-insensitive.

Supported Fields: name

Example:search=name:new%20york

viewstring

Specifies which fields are returned in the response.

Available Views:

BASIC: Returns insertion order metadata only.
PROGRESS: Returns insertion order metadata and current insertion order progress information.

Default:"BASIC"

Enum:"BASIC""PROGRESS"

curl -i -X GET \
  'https://platform-api.vistarmedia.com/api/dsp/v1/insertion_orders?page_size=0&page=0&order=string&asc=true&filter=in_flight%3Atrue&search=name%3Anew%2520york&view=BASIC' \
  -H 'Cookie: YOUR_API_KEY_HERE'

Responses

Operation completed successfully.

Bodyapplication/json

insertion_ordersArray of objects(api.dsp.v1.InsertionOrder)

total_sizeinteger, (int64)

Example:1

Response

{
  "insertion_orders": [
    { … }
  ],
  "total_size": 1
}