get

get https://{buzz_key}.api.beeswax.com/rest/v2/campaigns/{id}

Get a campaign by ID

Response

Response body

object

integer

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 | null

name

string

required

length between 3 and 191

active

boolean

Defaults to false

Whether the object is active

advertiser_id

integer

required

bid_modifier_id

integer | null

delivery_modifier_id

integer | 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

min_bid

string | null

-100000000 to 100000000

max_bid

string | null

-100000000 to 100000000

continents

array of strings

JSON list of continents, e.g. '["EMEA", "NAM"]'. Options include: 'APAC', 'EMEA' and 'NAM'.

continents

default_line_item_preset_id

integer | null

default_targeting_preset_id

integer | null

start_date

date-time | null

end_date

date-time | null

skad_network

object | null

enable_skad_tracking

boolean

required

Whether the Apple's SKAd Network tracking is enabled.

revenue

object | null

The configuration of the revenue.

type

string

required

The type of the revenue. One of: "CPM", "CPC", "CPCV", "CPI", "CPA".

amount

string

required

0 to 1000000000000

The basis of the revenue calculation, e.g. 5.125.

spend

string

-1000000000000 to 1000000000000

impressions

integer

Defaults to 0

The total number of impressions served for the campaign.

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.

lifetime

string

required

0.01 to 1000000000000

The maximum amount that can be spent or delivered., e.g. 700.35.

daily

string | null

0 to 1000000000000

The maximum amount that can be spent or delivered per day., e.g. 50.25.

include_fees

string

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.

lifetime

integer

required

≥ 0.01

The maximum amount that can be spent or delivered., e.g. 700.

daily

integer | null

≥ 0

The maximum amount that can be spent or delivered per day., e.g. 50.

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.

ghost_bidding

object | null

id_type

string

required

STANDARD IP_ADDR PERSON HOUSEHOLD

id_vendor

string | null

id_vendor_id

integer | null

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.

id_type

string

required

The type of frequency capping method.

STANDARD IP_ADDR CUSTOMER PERSON HOUSEHOLD

use_fallback

boolean | null

required

Whether the frequency capping type is used with a fallback.

id_vendor

string | null

Extends the frequency cap with the device graph. The valid value depends on which vendors have been enabled at the system level. Fees may apply.

id_vendor_id

integer | null

The unique identifier of the frequency cap vendor.

limits

array of objects

required

The set of caps that limits the number of times the ad appears.

limits*

object

duration

integer

required

≥ 1

The duration of time in which to cap impressions, e.g. 864000 seconds.

impressions

integer

required

≥ 1

The number of impressions to allow within the duration set.

segment_extension

object | null

The configuration of the segment extension.

extension_type

string

required

The default type of person and household segment extension.

person household person_extend_only household_extend_only

segment_type

string

required

The type of segment extension.

all 1st_party 3rd_party

vendors

array of objects

required

The list of vendors to use for audience extension.

vendors*

object

integer

≥ 1

name

string

The name of the vendor.

liveramp tapad freewheel

experiment

object | null

id_type

string

required

The type of the experiment.

STANDARD IP_ADDR PERSON HOUSEHOLD

id_vendor

string | null

The valid value depends on which vendors have been enabled at the system level.

id_vendor_id

integer | null

The unique identifier of the experiment.

id_test_plan_id

integer

line_items

array of objects

line_items

object

integer

required

name

string

required

length ≤ 191

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

test_group

integer

required

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

account_id

string

was_activated

string

Whether the campaign was already activated at least once.

invoice_id

string | null

Coming soon.

Language

URL


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

Choose an example:

application/json

200