"docs.beeswax.com" has a new address: "api-docs.freewheel.tv/beeswax." Please update your bookmarks accordingly.

Line item Configuration

Creating a line item

Full API Documentation can be found here.

In order to create or modify line items with the Buzz API, you will need to use the line item endpoint. This example shows the creation of a new line item, you can use a GET request to access it later. Fields will be discussed in more detail below.

In order to create, you will need to POST to the API
HTTP Method: POST
URL: https://<--your-buzz-key-->.api.beeswax.com/rest/v2/line-items

curl --request POST \
     --url https://stingersbx.api.beeswax.com/rest/v2/line-items \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "campaign_id": 0,
  "name": "string",
  "active": false,
  "type": "string",
  "bid_modifier_id": 0,
  "delivery_modifier_id": 0,
  "targeting_expression_id": 0,
  "start_date": "2023-09-11T17:50:32.674Z",
  "end_date": "2023-09-11T17:50:32.674Z",
  "alternative_id": "string",
  "notes": "string",
  "currency": "string",
  "guaranteed": true,
  "min_bid": "string",
  "max_bid": "string",
  "bidding": {
    "strategy": "string",
    "pacing": "daily",
    "custom": true,
    "bid_shading_control": "less_aggressive"
  },
  "skad_network": {
    "enable_skad_tracking": true,
    "assignment_level": "creative_line_item",
    "target_skad": true
  },
  "revenue": {
    "type": "string",
    "amount": "string"
  },
  "budget_type": "string",
  "spend_budget": {
    "lifetime": "string",
    "daily": "string"
  },
  "impressions_budget": {
    "lifetime": 0,
    "daily": 0
  },
  "vendor_fees": [
    {
      "id": 0,
      "vendor": "string",
      "vendor_id": 0,
      "name": "string",
      "cpm_currency": "string",
      "cpm_amount": "string",
      "percentage": "string"
    }
  ],
  "active_flights": [
    {
      "id": 0,
      "name": "",
      "start_date": "2023-09-11T17:50:32.674Z",
      "end_date": "2023-09-11T17:50:32.674Z",
      "spend_budget": "string",
      "impressions_budget": 0
    }
  ],
  "ghost_bidding": {
    "id_type": "STANDARD",
    "id_vendor": "string",
    "id_vendor_id": 0
  },
  "event_ids": [
    "string"
  ],
  "frequency_caps": {
    "id_type": "STANDARD",
    "use_fallback": "string",
    "id_vendor": "string",
    "id_vendor_id": 0,
    "limits": [
      {
        "duration": 0,
        "impressions": 0
      }
    ]
  },
  "segment_extension": {
    "extension_type": "person",
    "segment_type": "all",
    "vendors": [
      {
        "id": 0,
        "name": "liveramp"
      }
    ]
  },
  "test_group_id": 0,
  "user_timezones": [
    "string"
  ]
}
'