segment

post

https://buzz-key.api.beeswax.com/rest/segment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

segment_name*
string
Name of the Segment. <255 chars

Note: Segment name and segment description must begin with a letter or number.

Body Params

segment_name

string

required

Name of the Segment. <191 chars

alternative_id

string

Defaults to 0

Unlike other objects, the alternative_id for segments must be unique per account. This enables the use of the alternative_id as a segment identifier when using the segment_upload method by setting the segment_key_type field.

advertiser_id

int32

Segments may belong to the overall Account or to a single Advertiser.

segment_description

string

Longer description of the segment

cpm_cost

double

Cost to track for the segment

ttl_days

int32

Defaults to 30

Number of days to keep users in the segment. Max 90. Cannot be changed once set.

aggregate_excludes

boolean

Defaults to false

Should reporting include this segment when it is used as a negative target ("NOT")

active

boolean

Defaults to true

Indicates a segment’s archival status — when set to true, the segment remains active and is available for selection in targeting, whereas when set to false, it is archived and hidden from the options.

Response

200200