post
https://sandbox-api.viantinc.com/{basePath}/flight/createByAdOrder/
Creates new Order Flights for a given Ad Order. Notes: The new Order Flight’s Start Date must begin after the current time. An Order Flight’s Start Date and End Date cannot overlap with another Order Flight’s Start Date and End Date within the given Ad Order.
Request
POST /flight/byAdOrder/<ad order id>
Request Body
| Name | Type | Description | Required |
|---|---|---|---|
| budgetType | string |
One of:
|
|
| dailyBudget | string | ||
| dailyFrontload | integer | ||
| maxBudget | integer | ||
| dailyImpCap | integer | ||
| lifetimeImpCap | integer | ||
| startDate | integer | ||
| endDate | integer |
Response
| JSON Fields | Type | Description |
|---|---|---|
| messages | Object Array | An array of any error messages. |
| messages[].level | String | Error level. |
| messages[].code | String | Error code. |
| messages[].message | String | Error message. |
| entity | Object Array | An array of Order Flight objects. |
| entity[].id | Number | Order Flight ID |
| entity[].startDate | Number | Start date of the Order Flight, passed as Unix time in milliseconds. |
| entity[].endDate | Number | End date of the Order Flight, passed as Unix time in milliseconds. |
| entity[].budgetType | String | FIXED_BUDGET or AUTO_BUDGET |
| entity[].dailyBudget | Number | |
| entity[].dailyFrontload | Number | |
| entity[].dailyImpCap | Number | |
| entity[].lifetimeImpCap | Number | |
| entity[].maxBudget | Number | The total budget for the order flight in USD. |
Example
Request
curl -X POST -H "Content-Type: application/json" -u <user>:<password> -d '[
{
"budgetType": "AUTO_BUDGET",
"dailyBudget": 100,
"dailyFrontload": 3,
"maxBudget": 5003,
"dailyImpCap": 3,
"lifetimeImpCap": null,
"startDate": 1517529600000,
"endDate": 1521175792000
}
]' https://sandbox-api.viant.com/v1/flight/createByAdOrder/468674Response
{
"messages": [],
"entity": [
{
"id": 131135,
"budgetType": "AUTO_BUDGET",
"dailyBudget": 100,
"dailyFrontload": 3,
"maxBudget": 5003,
"remainingBudget": null,
"dailyImpCap": 3,
"lifetimeImpCap": null,
"startDate": 1517529600000,
"endDate": 1521175792000
}
]
}