Getting Started
- A line item holds promoted products to advertise on a single retailer.
- Line items include basic settings such as start and end dates, optional budget controls, and the associated retailer where ads are served.
- Budgets can also be managed at the campaign level.
- Several reports are available to track line item performance.
- Campaigns are limited to 10,000 non-archived line items.
- Line items are automatically archived 90 days after their end date.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /accounts/{accountId}/line-items | Retrieve all line items associated with a specific account. |
| GET | /line-items/{lineItemId} | Retrieve details of a specific line item by its ID. |
Line Item Attributes
| Attribute | Data Type | Description |
|---|---|---|
id | string | Line item IDAccepted values: string of int64 Writeable? N / Nullable? N |
name | string | Line item name, must be unique within a campaignAccepted values: up to 255-chars string Writeable? Y / Nullable? N |
campaignId | string | Campaign ID, in which the respective line item belongsAccepted values: string of int64 Writeable? N / Nullable? N |
type | enum | Campaign typeAccepted values: auction, preferred Writeable? Y / Nullable? N |
targetRetailerId | string | Retailer ID, in which the respective line item serves ad onAccepted values: string of int64 Writeable? N / Nullable? N |
startDate | date | Start date of the line item, in the Account timezone; used to schedule its activation and start serving ads. To understand the conditions that will cause a status to change, check out Campaign & Line Item StatusAccepted values: yyyy-mm-dd Writeable? Y / Nullable? N |
endDate | date | End date of the line item, in the Account timezone; serves ads indefinitely if omitted or set to null. A timestamp can be included as well if the line item is desired to end at a certain time of dayAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm (in ISO-8601 ) Default: if null or absent, balance will be available indefinitely Writeable? Y / Nullable? Y |
budget | decimal | Line item lifetime spend cap, uncapped if omitted or set to nullAccepted values: budget ≥ 0.0 Default: 0.0 Writeable? Y / Nullable? Y |
budgetSpent | decimal | Budget amount the line item has already spentAccepted values: budgetSpent ≥ 0.0 Default: 0.0 Writeable? N / Nullable? N |
budgetRemaining | decimal | Budget amount the line item has remaining until cap is hit; null if budget is uncappedAccepted values: 0 ≤ budgetRemaining ≤ budget Default: 0.0 Writeable? N / Nullable? Y |
status | enum | Line item status; can only be updated by a user to active or paused; all other values are applied automatically depending on financials, flight dates, or missing attributes required for line item to serve. To understand the conditions that will cause a status to change, check out Campaign & Line Item StatusAccepted values: active, paused, scheduled, ended, budgetHit, noFunds, draft, archived Writeable? Y / Nullable? N |
createdAt | timestamp | Timestamp of line item creation, in UTCAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601) Writeable? N / Nullable? N |
updatedAt | timestamp | Timestamp of last line item update, in UTCAccepted values: yyyy-mm-ddThh:mm:ss±hh:mm(in ISO-8601) Default: same as createdAt Writeable? N / Nullable? N |
Get all Line Items
This endpoint lists all line items in the specified campaign. Results are paginated. Sample RequestGet a specific Line Item
This endpoint retrieves details for a specified line item by its ID Sample RequestResponses
| Response | Description |
|---|---|
🟢200 | Call completed successfully. The specified line item details are returned. |
🔴403 | API user is not authorized to make requests for the account ID. To request authorization, follow theauthorization requeststeps. |
🔴404 | Line item ID not found. Ensure thelineItemIdis correct and exists. |