Get Insertion Order by ID

Marketplace DSP API

/API Reference/

Request

Returns an individual insertion order, optionally with progress information.

Security

SessionCookie

Path

idstringrequired

Query

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/{id}?view=BASIC' \
  -H 'Cookie: YOUR_API_KEY_HERE'

Responses

Operation completed successfully.

Bodyapplication/json

idstring

Example:"juIGaOygS0CBBqtmXHamqA"

create_timestring, (date-time)

The date and time the insertion order was created.

Example:"2004-09-22T16:16:42Z"

update_timestring, (date-time)

The date and time the insertion order was last updated.

Example:"2004-09-22T16:16:42Z"

archivedboolean

Shows whether the insertion order is archived. If true, the insertion order is archived and isn't returned by the API or displayed in the DSP by default.

advertiser_idstring

The ID of the insertion order's advertiser. You can set the advertiser only when you create the insertion order.

Example:"juIGaOygS0CBBqtmXHamqA"

contract_numberstring

A contract number associated with the insertion order. Contract numbers are for the buyer's use and aren't used by the DSP.

Example:"C-102930"

namestring

The insertion order's name for display purposes.

Example:"My Insertion Order Name"

start_timestring, (date-time)

The insertion order's flight start time.

Example:"2004-09-22T16:16:42Z"

end_timestring, (date-time)

The insertion order's flight end time.

Example:"2004-09-22T17:16:42Z"

budget_impressionsstring, (uint64)

The target impression budget for the insertion order. This field is mutually exclusive with budget_money.

Example:"10000"

budget_moneyobject(google.type.Money)

The target spend budget for the insertion order. This field is mutually exclusive with budget_impressions. Specify the budget in the seat's billing currency.

progressobject(api.dsp.v1.Progress)

The insertion order's delivery progress information.

creative_idsArray of strings

Response

{
  "id": "juIGaOygS0CBBqtmXHamqA",
  "create_time": "2004-09-22T16:16:42Z",
  "update_time": "2004-09-22T16:16:42Z",
  "archived": true,
  "advertiser_id": "juIGaOygS0CBBqtmXHamqA",
  "contract_number": "C-102930",
  "name": "My Insertion Order Name",
  "start_time": "2004-09-22T16:16:42Z",
  "end_time": "2004-09-22T17:16:42Z",
  "budget_impressions": "10000",
  "budget_money": {
    "currency_code": "USD",
    "units": "1",
    "nanos": 750000000
  },
  "progress": {
    "impressions_delivered": "10000",
    "money_spent": { … }
  },
  "creative_ids": [
    "string"
  ]
}