get

get https://{buzz_key}.api.beeswax.com/rest/v2/line-items

The Line Item is a key component of the Buzz system, defining objectives, budget, timing, and delivery details for a portion of a Campaign.
Each Line Item is associated to a single Campaign and may be associated with one or more Creatives through the Creative Line Item Association.
With a specific Targeting Expression, the Line Item executes buying activities based on a set of criteria, ensuring the successful delivery of targeted advertising.

Get a list of line items

Response

Response body

object

count

integer

uri | null

results

array of objects

results

object

integer

account_id

string

create_date

date-time | null

The date and time the object was first created

update_date

date-time | null

The date and time the object was last updated

last_active

date-time

The last time the object was deactivated.

advertiser_id

string | null

The unique identifier of the advertiser that owns the line item.

campaign_id

integer

required

The unique identifier of the campaign the line item belongs to.

name

string

required

length ≤ 191

The descriptive name of the line item, e.g. "Spring lead generation".

active

boolean

Defaults to false

Whether the object is active

type

string

required

The type of the line item. One of: "banner", "video", "native".

bid_modifier_id

integer | null

The unique identifier of the bid modifier. If it is set, max_bid must also be specified.

delivery_modifier_id

integer | null

The unique identifier of the delivery modifier.

targeting_expression_id

integer | null

The unique identifier of the targeting expression.

start_date

date-time | null

end_date

date-time | null

alternative_id

string | null

An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.

notes

string | null

Free-form notes of up to 255 characters.

currency

string

The currency code in which both lifetime and daily budgets are expressed, e.g. USD.

guaranteed

boolean

Whether the line item is programmatically guaranteed.

min_bid

string | null

-100000000 to 100000000

The minimum bid after taking into consideration any bid modifier, e.g. 1.23.

max_bid

string | null

-100000000 to 100000000

The maximum bid after taking into consideration any bid modifier, e.g. 7.89.

bidding

object | null

The configuration of the bidding strategy and its related settings. It may include information such as the bidding algorithm used and any additional parameters or constraints. Note: When updating the pacing option for the same strategy via a PATCH call, the fields pacing_behavior, multiplier, and catchup_behavior will be reset to their default values.

skad_network

object | null

The configuration of the SKAd network.

revenue

object | null

The configuration of the revenue.

spend

string

-1000000000000 to 1000000000000

The total spend of the line item so far.

impressions

integer

Defaults to 0

The total number of impressions served for the line item.

budget_type

string

The type of the budget. One of: "spend", "impressions", "spend including vendor fees".

spend_budget

object | null

The representation of the budget if the budget type is either "spend" or "spend including vendor fees". If the budget type is "impressions", null will be populated.

impressions_budget

object | null

The representation of the budget if the budget type is "impressions". If the budget type is either "spend" or "spend including vendor fees", null will be populated.

budget_carry_over_type

string | null

Options field to calculate carry-budget over and total budget for flights depends on selection calculate carry/total budget.

None carry_over evenly_distribute prorated_distribute

vendor_fees

array of objects

The list of the vendor fees objects.

vendor_fees

object

integer

vendor

string

The vendor associated with the vendor fee. Note that if vendor_id is also provided, both fields must be the same.

vendor_id

integer

The unique identifier of the vendor associated with the vendor fee. Note that if vendor is also provided, both fields must be the same.

name

string

required

length ≤ 100

The descriptive name of the vendor fee.

cpm_currency

string | null

The currency code for the CPM fee amount, e.g. USD.

cpm_amount

string | null

0 to 1000

The fee amount of the CPM, e.g. 90.123. Note that only one of cpm_amount and percentage can be specified.

percentage

string | null

0 to 900

The fee amount in a percentage.

active_flights

array of objects

The list of flights with an end date greater than the current time.

active_flights

object

integer

name

string

length ≤ 191

The descriptive name of the flight. This field can be left blank.

start_date

date-time

required

end_date

date-time | null

required

spend_budget

string | null

0 to 1000000000000

The budget for the flight in currency amount, e.g. 100.12. This field is optional and can be left blank or null. Note that if impressions_budget is provided, this field will be ignored.

impressions_budget

integer | null

≥ 0

The budget for the flight in impressions, e.g. 100. This field is optional and can be left blank or null. Note that if spend_budget is provided, this field will be ignored.

on_schedule_indicator

string

0 to 1000000000000

The metric used to measure how well a line item is pacing against its goal. The OSI is calculated as a percentage.

days_remaining

string

The days remaining until the end date of a flight line item.

hours_remaining_percentage

string

The hours remaining until the end date of a flight line item. The hours remaining is calculated as a percentage.

spend

string

0 to 1000000000000

Actual Spend budget within flight from Stats.

impressions

string

0 to 1000000000000

Actual Impressions within flight from stats table.

flight_budget_percentage

string

0 to 1000000000000

Calculate Actual Budget within flight, Flight budget is calculated as a percentage.

budget_carry_over

string

0 to 100000000

How much carry-over budget is attributed to that flight.

total_budget

string

0 to 1000000000000

The target budget sum and how much carry-over budget is attributed to that flight.

past_flights

array of objects

The list of flights whose end date is in the past.

past_flights

object

integer

name

string

length ≤ 191

The descriptive name of the flight. This field can be left blank.

start_date

date-time

required

end_date

date-time | null

required

spend_budget

string | null

0 to 1000000000000

The budget for the flight in currency amount, e.g. 100.12. This field is optional and can be left blank or null. Note that if impressions_budget is provided, this field will be ignored.

impressions_budget

integer | null

≥ 0

The budget for the flight in impressions, e.g. 100. This field is optional and can be left blank or null. Note that if spend_budget is provided, this field will be ignored.

on_schedule_indicator

string

0 to 1000000000000

The metric used to measure how well a line item is pacing against its goal. The OSI is calculated as a percentage.

days_remaining

string

The days remaining until the end date of a flight line item.

hours_remaining_percentage

string

The hours remaining until the end date of a flight line item. The hours remaining is calculated as a percentage.

spend

string

0 to 1000000000000

Actual Spend budget within flight from Stats.

impressions

string

0 to 1000000000000

Actual Impressions within flight from stats table.

flight_budget_percentage

string

0 to 1000000000000

Calculate Actual Budget within flight, Flight budget is calculated as a percentage.

budget_carry_over

string

0 to 100000000

How much carry-over budget is attributed to that flight.

total_budget

string

0 to 1000000000000

The target budget sum and how much carry-over budget is attributed to that flight.

ghost_bidding

object | null

The configuration of the ghost bidding. This is used to assess media buy impact by predicting ad outcomes without sending them to the exchange.

event_ids

array of strings

The list of the unique identifiers representing the associated events.

event_ids

frequency_caps

object | null

The configuration of the frequency capping.

segment_extension

object | null

The configuration of the segment extension.

test_plan_id

integer

test_group_id

integer | null

The unique identifier of the test group. This field is used when using Experiments to separate users into different groups for testing purposes.

user_timezones

array of strings

The list of time zones in which the ad is expected to be served within.

user_timezones

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://stingersbx.api.beeswax.com/rest/v2/line-items \
3
     --header 'accept: application/json'

Choose an example:

application/json

200