Skip to main content
GET
Get list of presets that are available for user to activate from the dashboard dropdown

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Returns Array of Preset Objects

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