{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/rest/line_item","auth":"required","results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"line_item_id\": 1,\n            \"campaign_id\": 1,\n            \"advertiser_id\": 1,\n            \"line_item_type_id\": 0,\n            \"targeting_template_id\": null,\n            \"line_item_version\": 1,\n            \"line_item_name\": \"li name\",\n            \"line_item_budget\": 1000,\n            \"daily_budget\": null,\n            \"budget_type\": 0,\n            \"line_item_spend\": 0,\n            \"currency\": \"USD\",\n            \"frequency_cap\": [\n                {\n                    \"duration\": 500,\n                    \"impressions\": 1\n                }\n            ],\n            \"bidding\": {\n                \"bidding_strategy\": \"cpm\",\n                \"values\": {\n                    \"cpm_bid\": 1.12\n                },\n              \t\"custom\":false,\n              \t\"pacing\":\"none\"\n            },\n            \"creative_weighting_method\": \"RANDOM\",\n            \"pacing\": null,\n            \"bid_modifier_id\": 1,\n            \"delivery_modifier_id\": null,\n          \t\"max_bid\": 12.23,\n            \"test_plan_id\": null,\n            \"revenue_type\": null,\n            \"revenue_amount\": null,\n            \"start_date\": \"2015-01-01 00:00:00\",\n            \"end_date\": \"2016-01-01 00:00:00\",\n            \"push_status\": 0,\n            \"push_update\": true,\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 11:45:33\",\n            \"update_date\": \"2016-03-30 11:45:33\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"user_timezones\": [\"America/New_York\"],\n          \t\"active\": false,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET \"[host]/rest/line_item\" -b cookies.txt -d '{\"line_item_id\":1}'"}]},"method":"get","params":[{"name":"line_item_id","type":"int","default":"","desc":"Unique ID of the Line Item","required":false,"in":"query","ref":"","_id":"56fbf37f0023171700b96143"},{"name":"campaign_id","type":"int","default":"","desc":"Must be a valid and active Campaign","required":false,"in":"query","ref":"","_id":"56fbf3200256470e0052538a"},{"name":"advertiser_id","type":"int","default":"","desc":"Must belong to the same account as the Line Item and be active","required":false,"in":"query","ref":"","_id":"56c38f9c2d97560d00e23cba"},{"name":"alternative_id","type":"string","default":"","desc":"An alternative id to lookup the  Line Item, if desired","required":false,"in":"query","ref":"","_id":"56c38f9c2d97560d00e23cb9"},{"name":"line_item_type_id","type":"int","default":"","desc":"The type of the Line Item. 0=banner, 1=video.","required":false,"in":"query","ref":"","_id":"56fbf3200256470e00525389"},{"name":"line_item_name","type":"string","default":"","desc":"Name of the  Line Item, e.g. \"Winter lead generation\"","required":false,"in":"query","ref":"","_id":"56c39b11e1e4190d003429b7"},{"name":"bid_modifier_id","type":"int","default":"","desc":"ID of the Bid Modifier associated with this Line Item","required":false,"in":"query","ref":"","_id":"5a8c905f50b7dd003d708c4e"},{"name":"delivery_modifier_id","type":"int","default":"","desc":"ID of the Delivery Modifier associated with this Line Item","required":false,"in":"query","ref":"","_id":"5e3991887689ad002815b073"},{"name":"start_date","type":"datetime","default":"","desc":"Start date of the Line Item. No Line Items associated with the Campaign can have start dates prior to this date.","required":false,"in":"query","ref":"","_id":"56cf74c86c5d7a13005eeb82"},{"name":"end_date","type":"datetime","default":"","desc":"End date of the Line Item. No Line Items associated with the Campaign can have end dates after this date.","required":false,"in":"query","ref":"","_id":"56cf74c86c5d7a13005eeb81"},{"name":"create_date","type":"datetime","default":"","desc":"","required":false,"in":"query","ref":"","_id":"56cf74c86c5d7a13005eeb80"},{"name":"update_date","type":"datetime","default":"","desc":"","required":false,"in":"query","ref":"","_id":"56c39b11e1e4190d003429b2"}]},"next":{"description":"","pages":[]},"title":"line_item","type":"endpoint","slug":"line_item-2","excerpt":"","body":"","updates":[],"order":113,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56fbf4d7698bea2b00de70fb","editedParams2":true,"githubsync":"","project":"56c35c56c0c4630d004e864c","parentDoc":null,"user":"56c39c05bc41330d009f25d7","__v":7,"category":{"sync":{"isSync":false,"url":""},"pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"title":"Buzz API Reference","slug":"buzz-api-reference","order":1,"from_sync":false,"reference":true,"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","createdAt":"2016-02-25T17:53:10.154Z"},"createdAt":"2016-03-30T15:46:31.755Z","editedParams":true,"version":{"version":"0.5","version_clean":"0.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"_id":"56c35c56c0c4630d004e864f","createdAt":"2016-02-16T17:28:54.864Z","project":"56c35c56c0c4630d004e864c","releaseDate":"2016-02-16T17:28:54.864Z","__v":8}}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

line_item_id:
integer
Unique ID of the Line Item
campaign_id:
integer
Must be a valid and active Campaign
advertiser_id:
integer
Must belong to the same account as the Line Item and be active
alternative_id:
string
An alternative id to lookup the Line Item, if desired
line_item_type_id:
integer
The type of the Line Item. 0=banner, 1=video.
line_item_name:
string
Name of the Line Item, e.g. "Winter lead generation"
bid_modifier_id:
integer
ID of the Bid Modifier associated with this Line Item
delivery_modifier_id:
integer
ID of the Delivery Modifier associated with this Line Item
start_date:
datetime
Start date of the Line Item. No Line Items associated with the Campaign can have start dates prior to this date.
end_date:
datetime
End date of the Line Item. No Line Items associated with the Campaign can have end dates after this date.
create_date:
datetime
update_date:
datetime

Examples


Result Format