Link Search Menu Expand Document

PDF

lineitem object

Platform API


Provides line item details associated with orders, such as pricing, goals, and targeting.

The lineitem object has the following calls:

CallDescription
GET /lineitemList all line items.
GET /lineitem/available_fields?type_full=
<lineitem_type_full>&action=<create_or_full>
List the available_fields to create or update a line item of the specified type (such as lineitem.exchange).
GET /lineitem/get_passback_tagReturn pass back tags for defaulting line items.
GET /lineitem/line_item_UIDRead the specified line item.
GET /lineitem/line_item_UID/list_adsList ads for the specified line item.
GET /lineitem/lineitems_dashboard_widgetList data for the UI line item report on the dashboard.
GET /lineitem/performance/line_item_UIDGet the performance metrics for the specified line item within the (optional) date range.

Parameters:
   • start_date: A specific date in yyyy-mm-dd HH:MM:SS format OR an integer for the days backward from today. For example, 7 = “seven days ago” and 0 = “starting today” (inclusive).

   • end_date: A specific date in yyyy-mm-dd HH:MM:SS format OR a negative integer for the days from now. For example, -7 = “until seven days from now” and 0 = “before today” (exclusive).
GET /lineitem/traffic_informationList traffic data for the specified line items. Use POST to avoid any URL length issues.
POST /lineitemCreate a line item.
POST /lineitem/line_item_UID/cloneClone the specified line item.
POST /lineitem/line_item_UID/recycleRestart the specified line item.
POST /lineitem/line_item_UID/stopStop the specified line item and its ads.
POST /lineitem/traffic_informationList traffic data for the specified line items.
PUT /lineitemUpdate the specified line items.
PUT /lineitem/line_item_UIDUpdate the specified line item.
DELETE /lineitemDelete the specified line items.
DELETE /lineitem/line_item_UIDDelete the specified line item.

See also Creating a Line Item.