Skip to main content
POST
Get list of presets, filtered by parameters

Body

application/json

All fields optional. Filters are combined with AND.

page
integer
default:1

1-based page index for offset calculation

Required range: x >= 1
limit
integer
default:50

Page size; values above 50 are treated as 50

Required range: 1 <= x <= 50
goal
string

Exact match on presets.campaign_objective (Marketing API objective code, e.g. OUTCOME_TRAFFIC, OUTCOME_LEADS, or legacy values still stored in DB)

Example:

"OUTCOME_TRAFFIC"

vertical
string

SQL LIKE filter on presets.vertical (comma-separated slug list in DB); match is literal substring

Example:

"finance"

agency_id
integer

Only presets where master_agency_id equals this value

Example:

2345

partner_id
integer

Alias filter: same as agency_id (master_agency_id match)

Example:

2345

preset_name
string

Case-sensitive prefix match on title (LIKE 'value%')

Example:

"Travel"

excluded_preset_id
integer

Exclude this preset id from results

location
object

JSON_CONTAINS on audience_targeting.geo_locations for country, city, or region entries

Response

200 - application/json

Array of preset payloads (see #/components/schemas/Preset); browse does not include number_of_purchases

id
integer
Example:

1

title
string | null
Example:

"Travel Pack"

image
string<uri> | null

Absolute URL of the preset image; null if none

campaign_objective
string

Localized human-readable objective label from BoostedPages::objectivesList()

vertical
(string | null)[]

Display labels per stored vertical slug; entry may be null if the slug has no mapping

price
number<float>

Chargeable monthly price including boosterberg_fixed_fee

Example:

"19.99"

original_price
number<float>

Original price including boosterberg_fixed_fee

Example:

"29.99"

version
number<float>
Example:

1

private
boolean
platform
enum<string>
Available options:
all,
facebook,
instagram
Example:

"all"

audience_targeting
string | null
location_json
string | null

JSON string of location/geographic targeting payload

description
string | null
hashtags
string[]

Keywords from boosting conditions when advanced_settings is enabled; otherwise empty

reach

[] when advanced_settings is off; integer percentage when set; null when advanced_settings is on but no matching condition row

allowed_options
enum<string>[]

Subset of preset_allowed_options.option values enabled for this preset (see PresetAllowedOptions constants / getAll())

Available options:
location,
age,
gender,
tags,
advanced_settings,
cta
rating
number

Average preset review rating rounded to nearest whole number; 0 when there are no reviews

Example:

4

agency
object