Facebook Ads
Facebook Ads
Available methods
No Summary
GET /facebook-ads
Get list of Facebook Ads
Query string parameters
fields
Type: Array
Title: Fields
Read only: false
A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields
Type: Array
Title: Exclude Fields
Read only: false
A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count
Type: Integer
Title: Count
Read only: true
The number of records to return. Default value is 10 .
offset
Type: Integer
Title: Offset
Read only: false
The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0 .
sort_field
Type: String
Title: Sort By Field
Read only: false
Returns files sorted by the specified field.
Possible Values:
created_at
updated_at
end_time
sort_dir
Type: String
Title: Sort Direction
Read only: false
Determines the order direction for sorted results.
Response body parameters
facebook_ads
Type: Array
Title: No Title
Read only: false
No Description
Show properties
id
Type: String
Title: No Title
Read only: false
Unique ID of an Outreach
web_id
Type: Integer
Title: No Title
Read only: false
Web ID
name
Type: String
Title: No Title
Read only: false
Title or name of an Outreach
type
Type: String
Title: Outreach type
Read only: false
Supported Campaign, Ad, Page type
Possible Values:
regular
plaintext
rss
reconfirm
variate
absplit
automation
facebook
google
autoresponder
transactional
page
status
Type: String
Title: Outreach status
Read only: false
Campaign, Ad, or Page status
Possible Values:
save
paused
schedule
sending
sent
canceled
canceling
active
disconnected
somepaused
draft
completed
partialRejected
pending
rejected
published
unpublished
create_time
Type: String
Title: No Title
Read only: false
No Description
start_time
Type: String
Title: No Title
Read only: false
No Description
updated_at
Type: String
Title: No Title
Read only: false
No Description
canceled_at
Type: String
Title: No Title
Read only: false
No Description
published_time
Type: String
Title: No Title
Read only: false
No Description
has_segment
Type: Boolean
Title: No Title
Read only: false
No Description
report_summary
Type: Object
Title: No Title
Read only: false
No Description
Show properties
opens
Type: Integer
Title: No Title
Read only: false
No Description
unique_opens
Type: Integer
Title: No Title
Read only: false
No Description
open_rate
Type: Number
Title: No Title
Read only: false
No Description
clicks
Type: Integer
Title: No Title
Read only: false
No Description
subscriber_clicks
Type: Integer
Title: No Title
Read only: false
No Description
click_rate
Type: Number
Title: No Title
Read only: false
No Description
visits
Type: Integer
Title: No Title
Read only: false
No Description
unique_visits
Type: Integer
Title: No Title
Read only: false
No Description
conversion_rate
Type: Number
Title: No Title
Read only: false
No Description
subscribes
Type: Integer
Title: No Title
Read only: false
No Description
ecommerce
Type: Object
Title: No Title
Read only: false
No Description
Show properties
total_revenue
Type: Number
Title: No Title
Read only: false
No Description
currency_code
Type: String
Title: No Title
Read only: false
No Description
average_order_revenue
Type: Number
Title: No Title
Read only: false
No Description
impressions
Type: Number
Title: No Title
Read only: false
No Description
reach
Type: Integer
Title: No Title
Read only: false
No Description
total_sent
Type: Integer
Title: No Title
Read only: false
No Description
recipients
Type: Object
Title: List
Read only: false
List settings for the outreach
Show properties
list_id
Type: String
Title: List ID
Read only: false
The unique list id.
list_is_active
Type: Boolean
Title: List Status
Read only: true
The status of the list used, namely if it’s deleted or disabled.
list_name
Type: String
Title: List Name
Read only: true
The name of the list.
segment_text
Type: String
Title: Segment Text
Read only: true
A description of the segment used for the campaign. Formatted as a string marked up with HTML.
recipient_count
Type: Integer
Title: Recipient Count
Read only: true
Count of the recipients on the associated list. Formatted as an integer.
segment_opts
Type: Object
Title: Segment Options
Read only: false
An object representing all segmentation options. This object should contain a saved_segment_id
to use an existing segment, or you can create a new segment by including both match
and conditions
options.
Show properties
saved_segment_id
Type: Integer
Title: Saved Segment ID
Read only: false
The id for an existing saved segment.
prebuilt_segment_id
Type: String
Title: Prebuilt Segment Id
Read only: false
The prebuilt segment id, if a prebuilt segment has been designated for this campaign.
match
Type: String
Title: Match Type
Read only: false
Segment match type.
conditions
Type: Array
Title: Conditions
Read only: false
Segment match conditions.
Show items
condition_type
Type: string
Title: Segment Type
The type of segment, for example: date, language, Mandrill, static, and more.
Segment Type
Automation Segment - Aim
Automation Segment - Automation
Poll Activity Segment - CampaignPoll
Automation Segment - Conversation
Date Segment - Date
Automation Segment - EmailClient
Automation Segment - Language
Segment Condition - Mandrill
Member Rating Segment - MemberRating
Signup Source Segment - SignupSource
Survey Monkey Segment - SurveyMonkey
VIP Segment - VIP
Interests Segment - Interests
Ecomm Category Segment - EcommCategory
Ecomm Purchased Segment - EcommNumber
Ecomm Purchased Segment - EcommPurchased
Ecomm Purchase Segment - EcommSpent
Ecomm Purchased Store Segment - EcommStore
Goal Activity Segment - GoalActivity
Goal Timestamp Segment - GoalTimestamp
Similar Subscribers Segment Member Segment - FuzzySegment
Static Segment Member Segment - StaticSegment
Location-Based Segment - IPGeoCountryState
Geolocation Segment - IPGeoIn
US Zip Code Segment - IPGeoInZip
Location-Based Segment - IPGeoUnknown
Location-Based Segment - IPGeoZip
Social Profiles Age Segment - SocialAge
Social Profiles Gender Segment - SocialGender
Social Profiles Influence Segment - SocialInfluence
Social Profiles Social Network Segment - SocialNetworkMember
Social Profiles Social Network Follow Segment - SocialNetworkFollow
Address/Zip Merge Field Segment - AddressMerge
Address/Zip Merge Field Segment - ZipMerge
Birthday Merge Field Segment - BirthdayMerge
Date Merge Field Segment - DateMerge
Text or Number Merge Field Segment - TextMerge
Dropdown/Radio Merge Field Segment - SelectMerge
Email Segment - EmailAddress
Segment Condition - PredictedAge
Segment Condition - PredictedGender
Aim
Type: Object
Title: Automation Segment - Aim
Show properties
op
Type: String
Title: Operator
Read only: false
The member’s status, based on their campaign interaction.
Possible Values:
open
click
sent
noopen
noclick
nosent
field
Type: String
Title: Aim
Read only: false
The segment field, ‘aim’.
value
Type: String
Title: Campaign Web ID
Read only: false
Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
Automation
Type: Object
Title: Automation Segment - Automation
Show properties
op
Type: String
Title: Operator
Read only: false
The member’s status, based on where they are in an Automation workflow.
Possible Values:
started
completed
not_started
not_completed
field
Type: String
Title: Automation
Read only: false
The field to segment on.
value
Type: String
Title: Automation Web ID
Read only: false
The web id for the Automation workflow to segment on.
CampaignPoll
Type: Object
Title: Poll Activity Segment - CampaignPoll
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have or have not interacted with a specific poll in a Mailchimp email.
field
Type: String
Title: Campaign Poll
Read only: false
The field to segment on.
value
Type: Number
Title: Poll ID
Read only: false
The id for the poll.
Conversation
Type: Object
Title: Automation Segment - Conversation
Show properties
op
Type: String
Title: Operator
Read only: false
The status of a member’s interaction with a conversation.
field
Type: String
Title: Conversations
Read only: false
The field to segment on.
value
Type: String
Title: Campaign Web ID
Read only: false
The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
Date
Type: Object
Title: Date Segment - Date
Show properties
op
Type: String
Title: Operator
Read only: false
When the event took place.
Possible Values:
greater
less
is
not
blank
blank_not
field
Type: String
Title: Date
Read only: false
The date segment field.
Possible Values:
timestamp_opt
info_changed
ecomm_date
extra
Type: String
Title: Date
Read only: false
When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
value
Type: String
Title: Event Type
Read only: false
What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
EmailClient
Type: Object
Title: Automation Segment - EmailClient
Show properties
op
Type: String
Title: Operator
Read only: false
A member’s status, based on their campaign interactions.
field
Type: String
Title: Email Client
Read only: false
The field to segment on.
value
Type: String
Title: Email Client
Read only: false
The name of the email client.
Language
Type: Object
Title: Automation Segment - Language
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member’s language is or isn’t set to a specific language.
field
Type: String
Title: Language
Read only: false
The field to segment on.
value
Type: String
Title: Language ID
Read only: false
A two-letter language identifier.
Mandrill
Type: Object
Title: Segment Condition - Mandrill
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
MemberRating
Type: Object
Title: Member Rating Segment - MemberRating
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
field
Type: String
Title: Member Rating
Read only: false
The field to segment on.
value
Type: Number
Title: Start Rating
Read only: false
The star rating number to segment on.
SignupSource
Type: Object
Title: Signup Source Segment - SignupSource
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member’s signup source was/was not a particular value.
field
Type: String
Title: Signup Source
Read only: false
The field to segment on.
value
Type: String
Title: Signup Source
Read only: false
The signup source.
SurveyMonkey
Type: Object
Title: Survey Monkey Segment - SurveyMonkey
Show properties
op
Type: String
Title: Operator
Read only: false
A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
Possible Values:
started
completed
not_started
not_completed
field
Type: String
Title: Survey Monkey
Read only: false
The field to segment on.
value
Type: String
Title: Survey ID
Read only: false
The unique ID of the SurveyMonkey survey.
VIP
Type: Object
Title: VIP Segment - VIP
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member is or isn’t a VIP .
field
Type: String
Title: VIP
Read only: false
The field to segment on.
Interests
Type: Object
Title: Interests Segment - Interests
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member is a part of one, all, or none of the groups.
Possible Values:
interestcontains
interestcontainsall
interestnotcontains
field
Type: String
Title: Interest Group
Read only: false
The interest group, like “interests-123”
value
Type: Array
Title: Segment Value
Read only: false
An array containing integers, each representing a group id.
EcommCategory
Type: Object
Title: Ecomm Category Segment - EcommCategory
Show properties
op
Type: String
Title: Operator
Read only: false
A member who has purchased from a category or purchased a specific item.
Possible Values:
is
not
contains
notcontain
starts
ends
field
Type: String
Title: Ecomm Category or Product
Read only: false
The e-commerce category or product segment field.
value
Type: String
Title: Ecomm Category or Item
Read only: false
The e-commerce category or item information.
EcommNumber
Type: Object
Title: Ecomm Purchased Segment - EcommNumber
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
field
Type: String
Title: Ecomm Number
Read only: false
The e-commerce number field to segment on.
Possible Values:
ecomm_spent_avg
ecomm_orders
ecomm_prod_all
ecomm_avg_ord
value
Type: Number
Title: Amount Spent
Read only: false
Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
EcommPurchased
Type: Object
Title: Ecomm Purchased Segment - EcommPurchased
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have have (‘member’) or have not (‘notmember’) purchased.
field
Type: String
Title: Ecomm Purchased
Read only: false
The e-commerce purchased field to segment on.
EcommSpent
Type: Object
Title: Ecomm Purchase Segment - EcommSpent
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have spent more or less than the set value.
field
Type: String
Title: Ecomm Spent
Read only: false
The e-commerce spent field to segment on.
Possible Values:
ecomm_spent_one
ecomm_spent_all
value
Type: Integer
Title: Total Spent
Read only: false
The total amount a member spent.
EcommStore
Type: Object
Title: Ecomm Purchased Store Segment - EcommStore
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have or have not purchased from a specific store.
field
Type: String
Title: Ecomm Store
Read only: false
The e-commerce store field to segment on.
value
Type: String
Title: Store ID
Read only: false
The store id to segment on.
GoalActivity
Type: Object
Title: Goal Activity Segment - GoalActivity
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
Possible Values:
is
goal_not
contains
goal_notcontain
starts
ends
field
Type: String
Title: Goal Activity
Read only: false
The goal activity field to segment on.
value
Type: String
Title: Goal URL
Read only: false
The URL to check Goal activity against.
GoalTimestamp
Type: Object
Title: Goal Timestamp Segment - GoalTimestamp
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the website activity happened at, after, or before a specific date.
field
Type: String
Title: Goal Time
Read only: false
The goal time field to segment on.
extra
Type: String
Title: Date
Read only: false
The date for the segment, formatted as YYYY-MM-DD.
value
Type: String
Title: Event Type
Read only: false
What type of data to segment on.
FuzzySegment
Type: Object
Title: Similar Subscribers Segment Member Segment - FuzzySegment
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are/are not apart of a ‘similar subscribers’ segment.
field
Type: String
Title: Fuzzy Segment
Read only: false
The fuzzy segment field.
value
Type: Number
Title: Similar Subscribers Segment ID
Read only: false
The id for the ‘similar subscribers’ segment.
StaticSegment
Type: Object
Title: Static Segment Member Segment - StaticSegment
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are/are not apart of a static segment.
field
Type: String
Title: Static Segment
Read only: false
The static segment field.
value
Type: Number
Title: Static Segment ID
Read only: false
The id for the static segment.
IPGeoCountryState
Type: Object
Title: Location-Based Segment - IPGeoCountryState
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific country or US state.
Possible Values:
ipgeocountry
ipgeonotcountry
ipgeostate
ipgeonotstate
field
Type: String
Title: Country State
Read only: false
The field to segment on.
value
Type: String
Title: Country Code or US State
Read only: false
The two-letter country code or US state abbreviation.
IPGeoIn
Type: Object
Title: Geolocation Segment - IPGeoIn
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific geographic region.
lng
Type: String
Title: Segment Location Longitude
Read only: false
The longitude of the target location.
field
Type: String
Title: Location
Read only: false
The field to segment on.
addr
Type: String
Title: Segment Location Address
Read only: false
The address of the target location.
value
Type: Integer
Title: Target Location Radius
Read only: false
The radius of the target location.
lat
Type: String
Title: Segment Location Latitude
Read only: false
The latitude of the target location.
IPGeoInZip
Type: Object
Title: US Zip Code Segment - IPGeoInZip
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific US zip code.
field
Type: String
Title: Location in Zip
Read only: false
The field to segment on.
extra
Type: Integer
Title: Zip Code
Read only: false
The zip code to segment on.
value
Type: Integer
Title: Target Location Radius
Read only: false
The radius of the target location.
IPGeoUnknown
Type: Object
Title: Location-Based Segment - IPGeoUnknown
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members with unknown location information.
field
Type: String
Title: Unknown Location
Read only: false
The field to segment on.
IPGeoZip
Type: Object
Title: Location-Based Segment - IPGeoZip
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are or are not in a specific US zip code.
field
Type: String
Title: Zip
Read only: false
The field to segment on.
value
Type: Integer
Title: Zip Code
Read only: false
The 5-digit zip code.
SocialAge
Type: Object
Title: Social Profiles Age Segment - SocialAge
Show properties
op
Type: String
Title: Operator
Read only: false
Members who do or don’t match the exact criteria listed.
field
Type: String
Title: Social Age
Read only: false
The social age field to segment on.
value
Type: String
Title: Age Range
Read only: false
The age range to segment.
SocialGender
Type: Object
Title: Social Profiles Gender Segment - SocialGender
Show properties
op
Type: String
Title: Operator
Read only: false
Members who do or don’t match the exact criteria listed.
field
Type: String
Title: Social Gender
Read only: false
The social gender field to segment on.
value
Type: String
Title: Social Gender
Read only: false
The Social Profiles gender to segment.
SocialInfluence
Type: Object
Title: Social Profiles Influence Segment - SocialInfluence
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have a rating that is/not or greater/less than the rating provided.
field
Type: String
Title: Social Influence
Read only: false
The social influence field to segment on.
value
Type: Number
Title: Influence Rating
Read only: false
The Social Profiles influence rating to segment on.
SocialNetworkMember
Type: Object
Title: Social Profiles Social Network Segment - SocialNetworkMember
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are or are not on a specific social network.
field
Type: String
Title: Social Network
Read only: false
The social_network segment field.
value
Type: String
Title: Social Network
Read only: false
The social network to segment on.
Possible Values:
twitter
facebook
linkedin
flickr
foursquare
lastfm
myspace
quora
vimeo
yelp
youtube
SocialNetworkFollow
Type: Object
Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are or are not following a linked account on a specific social network.
field
Type: String
Title: Social Network Follow
Read only: false
The field to segment on.
value
Type: String
Title: Social Network
Read only: false
The social network to segment on.
AddressMerge
Type: Object
Title: Address/Zip Merge Field Segment - AddressMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
Possible Values:
contains
notcontain
blank
blank_not
field
Type: String
Title: Address Merge
Read only: false
The address merge segment field.
value
Type: String
Title: Address Merge Compare Value
Read only: false
The value to compare.
ZipMerge
Type: Object
Title: Address/Zip Merge Field Segment - ZipMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the zip value is in a specific location.
field
Type: String
Title: Zip Merge
Read only: false
The zip merge segment field.
extra
Type: String
Title: City or Zip
Read only: false
The city or the zip being used to segment on.
value
Type: String
Title: Zip Merge Compare Value
Read only: false
The value to compare.
BirthdayMerge
Type: Object
Title: Birthday Merge Field Segment - BirthdayMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
field
Type: String
Title: Birthday Merge
Read only: false
The birthday merge segment field.
value
Type: String
Title: Birthday Merge Compare Value
Read only: false
The value to compare.
DateMerge
Type: Object
Title: Date Merge Field Segment - DateMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
Possible Values:
is
not
less
blank
blank_not
field
Type: String
Title: Date Merge
Read only: false
The date merge segment field.
value
Type: String
Title: Date Merge Compare Value
Read only: false
The value to compare.
TextMerge
Type: Object
Title: Text or Number Merge Field Segment - TextMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
Possible Values:
is
not
contains
notcontain
starts
ends
greater
less
blank
blank_not
field
Type: String
Title: Text Merge
Read only: false
The segment field, one of ‘merge0’ or ‘EMAIL’.
value
Type: String
Title: Text Merge Compare Value
Read only: false
The value to compare.
SelectMerge
Type: Object
Title: Dropdown/Radio Merge Field Segment - SelectMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
field
Type: String
Title: Select
Read only: false
The select merge segment field.
value
Type: String
Title: Select Merge Compare Value
Read only: false
The value to compare.
EmailAddress
Type: Object
Title: Email Segment - EmailAddress
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
Possible Values:
is
not
contains
notcontain
starts
ends
greater
less
field
Type: String
Title: Email
Read only: false
The segment field, one of ‘merge0’ or ‘EMAIL’.
value
Type: String
Title: Email Compare Value
Read only: false
The value to compare the email against.
PredictedAge
Type: Object
Title: Segment Condition - PredictedAge
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
PredictedGender
Type: Object
Title: Segment Condition - PredictedGender
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
thumbnail
Type: String
Title: No Title
Read only: false
The URL of the thumbnail for this outreach
email_source_name
Type: String
Title: No Title
Read only: false
No Description
paused_at
Type: String
Title: No Title
Read only: false
No Description
end_time
Type: String
Title: No Title
Read only: false
No Description
needs_attention
Type: Boolean
Title: No Title
Read only: false
No Description
was_canceled_by_facebook
Type: Boolean
Title: No Title
Read only: false
No Description
is_connected
Type: Boolean
Title: No Title
Read only: false
Check if this ad is connected to a facebook page
has_audience
Type: Boolean
Title: No Title
Read only: false
Check if this ad has audience setup
has_content
Type: Boolean
Title: No Title
Read only: false
Check if this ad has content
channel
Type: Object
Title: No Title
Read only: false
Channel settings
Show properties
fb_placement_feed
Type: Boolean
Title: No Title
Read only: false
Is this for facebook feed
fb_placement_audience
Type: Boolean
Title: No Title
Read only: false
Is this for facebook audience
ig_placement_feed
Type: Boolean
Title: No Title
Read only: false
Is this for instagram feed
feedback
Type: Object
Title: No Title
Read only: false
Check if this ad is connected to a facebook page
Show properties
content
Type: String
Title: No Title
Read only: false
Feedback regarding the content of this Ad.
audience
Type: String
Title: No Title
Read only: false
Feedback regarding the audience of this Ad.
budget
Type: String
Title: No Title
Read only: false
Feedback regarding the budget of this Ad.
compliance
Type: String
Title: No Title
Read only: false
Feedback regarding the compliance of this Ad.
audience
Type: Object
Title: No Title
Read only: false
Audience settings
Show properties
type
Type: String
Title: No Title
Read only: false
Type of the audience
Possible Values:
Custom Audience
Lookalike Audience
Interest-based Audience
source_type
Type: String
Title: No Title
Read only: false
List or Facebook based audience
email_source
Type: Object
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
Email source name
type
Type: String
Title: No Title
Read only: false
Type of the email source
is_segment
Type: Boolean
Title: No Title
Read only: false
Is the source reference a segment
segment_type
Type: String
Title: No Title
Read only: false
Segment type if this source is tied to a segment
list_name
Type: String
Title: No Title
Read only: false
Associated list name to the source
include_source_in_target
Type: Boolean
Title: No Title
Read only: false
To include list contacts as part of audience
lookalike_country_code
Type: String
Title: No Title
Read only: false
To find similar audience in given country
targeting_specs
Type: Object
Title: No Title
Read only: false
No Description
Show properties
gender
Type: Integer
Title: No Title
Read only: false
No Description
min_age
Type: Integer
Title: No Title
Read only: false
No Description
max_age
Type: Integer
Title: No Title
Read only: false
No Description
locations
Type: Object
Title: No Title
Read only: false
No Description
Show properties
countries
Type: Array
Title: No Title
Read only: false
No Description
regions
Type: Array
Title: No Title
Read only: false
No Description
cities
Type: Array
Title: No Title
Read only: false
No Description
zips
Type: Array
Title: No Title
Read only: false
No Description
interests
Type: Array
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
No Description
budget
Type: Object
Title: No Title
Read only: false
No Description
Show properties
duration
Type: Integer
Title: No Title
Read only: false
Duration of the ad in seconds
total_amount
Type: Number
Title: No Title
Read only: false
Total budget of the ad
currency_code
Type: String
Title: No Title
Read only: false
Currency code
content
Type: Object
Title: No Title
Read only: false
No Description
Show properties
title
Type: String
Title: No Title
Read only: false
No Description
link_url
Type: String
Title: No Title
Read only: false
No Description
message
Type: String
Title: No Title
Read only: false
No Description
description
Type: String
Title: No Title
Read only: false
No Description
image_url
Type: String
Title: No Title
Read only: false
No Description
call_to_action
Type: String
Title: No Title
Read only: false
No Description
attachments
Type: Array
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
No Description
link_url
Type: String
Title: No Title
Read only: false
No Description
description
Type: String
Title: No Title
Read only: false
No Description
image_url
Type: String
Title: No Title
Read only: false
No Description
call_to_action
Type: String
Title: No Title
Read only: false
No Description
_links
Type: Array
Title: Links
Read only: true
A list of link types and descriptions for the API schema documents.
Show properties
rel
Type: String
Title: Rel
Read only: true
As with an HTML ‘rel’ attribute, this describes the type of link.
href
Type: String
Title: Href
Read only: true
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
method
Type: String
Title: Method
Read only: true
The HTTP method that should be used when accessing the URL defined in ‘href’.
Possible Values:
GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD
targetSchema
Type: String
Title: Target Schema
Read only: true
For GETs, this is a URL representing the schema that the response should conform to.
schema
Type: String
Title: Schema
Read only: true
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
total_items
Type: Integer
Title: Item Count
Read only: false
The total number of items matching the query regardless of pagination.
_links
Type: Array
Title: Links
Read only: true
A list of link types and descriptions for the API schema documents.
Show properties
rel
Type: String
Title: Rel
Read only: true
As with an HTML ‘rel’ attribute, this describes the type of link.
href
Type: String
Title: Href
Read only: true
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
method
Type: String
Title: Method
Read only: true
The HTTP method that should be used when accessing the URL defined in ‘href’.
Possible Values:
GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD
targetSchema
Type: String
Title: Target Schema
Read only: true
For GETs, this is a URL representing the schema that the response should conform to.
schema
Type: String
Title: Schema
Read only: true
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
Error response
type
Type: String
Title: Problem Type
Read only: false
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
title
Type: String
Title: Error Title
Read only: false
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
status
Type: Integer
Title: HTTP Status Code
Read only: false
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
detail
Type: String
Title: Error Message
Read only: false
A human-readable explanation specific to this occurrence of the problem. Learn more about errors .
instance
Type: String
Title: Instance ID
Read only: false
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
No Summary
GET /facebook-ads/{outreach_id}
Get details of a facebook ad
Query string parameters
fields
Type: Array
Title: Fields
Read only: false
A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields
Type: Array
Title: Exclude Fields
Read only: false
A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
Response body parameters
id
Type: String
Title: No Title
Read only: false
Unique ID of an Outreach
web_id
Type: Integer
Title: No Title
Read only: false
Web ID
name
Type: String
Title: No Title
Read only: false
Title or name of an Outreach
type
Type: String
Title: Outreach type
Read only: false
Supported Campaign, Ad, Page type
Possible Values:
regular
plaintext
rss
reconfirm
variate
absplit
automation
facebook
google
autoresponder
transactional
page
status
Type: String
Title: Outreach status
Read only: false
Campaign, Ad, or Page status
Possible Values:
save
paused
schedule
sending
sent
canceled
canceling
active
disconnected
somepaused
draft
completed
partialRejected
pending
rejected
published
unpublished
create_time
Type: String
Title: No Title
Read only: false
No Description
start_time
Type: String
Title: No Title
Read only: false
No Description
updated_at
Type: String
Title: No Title
Read only: false
No Description
canceled_at
Type: String
Title: No Title
Read only: false
No Description
published_time
Type: String
Title: No Title
Read only: false
No Description
has_segment
Type: Boolean
Title: No Title
Read only: false
No Description
report_summary
Type: Object
Title: No Title
Read only: false
No Description
Show properties
opens
Type: Integer
Title: No Title
Read only: false
No Description
unique_opens
Type: Integer
Title: No Title
Read only: false
No Description
open_rate
Type: Number
Title: No Title
Read only: false
No Description
clicks
Type: Integer
Title: No Title
Read only: false
No Description
subscriber_clicks
Type: Integer
Title: No Title
Read only: false
No Description
click_rate
Type: Number
Title: No Title
Read only: false
No Description
visits
Type: Integer
Title: No Title
Read only: false
No Description
unique_visits
Type: Integer
Title: No Title
Read only: false
No Description
conversion_rate
Type: Number
Title: No Title
Read only: false
No Description
subscribes
Type: Integer
Title: No Title
Read only: false
No Description
ecommerce
Type: Object
Title: No Title
Read only: false
No Description
Show properties
total_revenue
Type: Number
Title: No Title
Read only: false
No Description
currency_code
Type: String
Title: No Title
Read only: false
No Description
average_order_revenue
Type: Number
Title: No Title
Read only: false
No Description
impressions
Type: Number
Title: No Title
Read only: false
No Description
reach
Type: Integer
Title: No Title
Read only: false
No Description
total_sent
Type: Integer
Title: No Title
Read only: false
No Description
recipients
Type: Object
Title: List
Read only: false
List settings for the outreach
Show properties
list_id
Type: String
Title: List ID
Read only: false
The unique list id.
list_is_active
Type: Boolean
Title: List Status
Read only: true
The status of the list used, namely if it’s deleted or disabled.
list_name
Type: String
Title: List Name
Read only: true
The name of the list.
segment_text
Type: String
Title: Segment Text
Read only: true
A description of the segment used for the campaign. Formatted as a string marked up with HTML.
recipient_count
Type: Integer
Title: Recipient Count
Read only: true
Count of the recipients on the associated list. Formatted as an integer.
segment_opts
Type: Object
Title: Segment Options
Read only: false
An object representing all segmentation options. This object should contain a saved_segment_id
to use an existing segment, or you can create a new segment by including both match
and conditions
options.
Show properties
saved_segment_id
Type: Integer
Title: Saved Segment ID
Read only: false
The id for an existing saved segment.
prebuilt_segment_id
Type: String
Title: Prebuilt Segment Id
Read only: false
The prebuilt segment id, if a prebuilt segment has been designated for this campaign.
match
Type: String
Title: Match Type
Read only: false
Segment match type.
conditions
Type: Array
Title: Conditions
Read only: false
Segment match conditions.
Show items
condition_type
Type: string
Title: Segment Type
The type of segment, for example: date, language, Mandrill, static, and more.
Segment Type
Automation Segment - Aim
Automation Segment - Automation
Poll Activity Segment - CampaignPoll
Automation Segment - Conversation
Date Segment - Date
Automation Segment - EmailClient
Automation Segment - Language
Segment Condition - Mandrill
Member Rating Segment - MemberRating
Signup Source Segment - SignupSource
Survey Monkey Segment - SurveyMonkey
VIP Segment - VIP
Interests Segment - Interests
Ecomm Category Segment - EcommCategory
Ecomm Purchased Segment - EcommNumber
Ecomm Purchased Segment - EcommPurchased
Ecomm Purchase Segment - EcommSpent
Ecomm Purchased Store Segment - EcommStore
Goal Activity Segment - GoalActivity
Goal Timestamp Segment - GoalTimestamp
Similar Subscribers Segment Member Segment - FuzzySegment
Static Segment Member Segment - StaticSegment
Location-Based Segment - IPGeoCountryState
Geolocation Segment - IPGeoIn
US Zip Code Segment - IPGeoInZip
Location-Based Segment - IPGeoUnknown
Location-Based Segment - IPGeoZip
Social Profiles Age Segment - SocialAge
Social Profiles Gender Segment - SocialGender
Social Profiles Influence Segment - SocialInfluence
Social Profiles Social Network Segment - SocialNetworkMember
Social Profiles Social Network Follow Segment - SocialNetworkFollow
Address/Zip Merge Field Segment - AddressMerge
Address/Zip Merge Field Segment - ZipMerge
Birthday Merge Field Segment - BirthdayMerge
Date Merge Field Segment - DateMerge
Text or Number Merge Field Segment - TextMerge
Dropdown/Radio Merge Field Segment - SelectMerge
Email Segment - EmailAddress
Segment Condition - PredictedAge
Segment Condition - PredictedGender
Aim
Type: Object
Title: Automation Segment - Aim
Show properties
op
Type: String
Title: Operator
Read only: false
The member’s status, based on their campaign interaction.
Possible Values:
open
click
sent
noopen
noclick
nosent
field
Type: String
Title: Aim
Read only: false
The segment field, ‘aim’.
value
Type: String
Title: Campaign Web ID
Read only: false
Either the web id value for a specific campaign or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
Automation
Type: Object
Title: Automation Segment - Automation
Show properties
op
Type: String
Title: Operator
Read only: false
The member’s status, based on where they are in an Automation workflow.
Possible Values:
started
completed
not_started
not_completed
field
Type: String
Title: Automation
Read only: false
The field to segment on.
value
Type: String
Title: Automation Web ID
Read only: false
The web id for the Automation workflow to segment on.
CampaignPoll
Type: Object
Title: Poll Activity Segment - CampaignPoll
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have or have not interacted with a specific poll in a Mailchimp email.
field
Type: String
Title: Campaign Poll
Read only: false
The field to segment on.
value
Type: Number
Title: Poll ID
Read only: false
The id for the poll.
Conversation
Type: Object
Title: Automation Segment - Conversation
Show properties
op
Type: String
Title: Operator
Read only: false
The status of a member’s interaction with a conversation.
field
Type: String
Title: Conversations
Read only: false
The field to segment on.
value
Type: String
Title: Campaign Web ID
Read only: false
The web id value for a specific campaign, or ‘any’ to account for subscribers who have or have not interacted with any campaigns.
Date
Type: Object
Title: Date Segment - Date
Show properties
op
Type: String
Title: Operator
Read only: false
When the event took place.
Possible Values:
greater
less
is
not
blank
blank_not
field
Type: String
Title: Date
Read only: false
The date segment field.
Possible Values:
timestamp_opt
info_changed
ecomm_date
extra
Type: String
Title: Date
Read only: false
When segmenting on ‘date’ or ‘campaign’, the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.
value
Type: String
Title: Event Type
Read only: false
What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.
EmailClient
Type: Object
Title: Automation Segment - EmailClient
Show properties
op
Type: String
Title: Operator
Read only: false
A member’s status, based on their campaign interactions.
field
Type: String
Title: Email Client
Read only: false
The field to segment on.
value
Type: String
Title: Email Client
Read only: false
The name of the email client.
Language
Type: Object
Title: Automation Segment - Language
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member’s language is or isn’t set to a specific language.
field
Type: String
Title: Language
Read only: false
The field to segment on.
value
Type: String
Title: Language ID
Read only: false
A two-letter language identifier.
Mandrill
Type: Object
Title: Segment Condition - Mandrill
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
MemberRating
Type: Object
Title: Member Rating Segment - MemberRating
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have have a rating that is/not exactly a specific number or members who have a rating greater/less than a specific number.
field
Type: String
Title: Member Rating
Read only: false
The field to segment on.
value
Type: Number
Title: Start Rating
Read only: false
The star rating number to segment on.
SignupSource
Type: Object
Title: Signup Source Segment - SignupSource
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member’s signup source was/was not a particular value.
field
Type: String
Title: Signup Source
Read only: false
The field to segment on.
value
Type: String
Title: Signup Source
Read only: false
The signup source.
SurveyMonkey
Type: Object
Title: Survey Monkey Segment - SurveyMonkey
Show properties
op
Type: String
Title: Operator
Read only: false
A member’s status based on whether they have started, completed, not started, or not completed a specific survey.
Possible Values:
started
completed
not_started
not_completed
field
Type: String
Title: Survey Monkey
Read only: false
The field to segment on.
value
Type: String
Title: Survey ID
Read only: false
The unique ID of the SurveyMonkey survey.
VIP
Type: Object
Title: VIP Segment - VIP
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member is or isn’t a VIP .
field
Type: String
Title: VIP
Read only: false
The field to segment on.
Interests
Type: Object
Title: Interests Segment - Interests
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the member is a part of one, all, or none of the groups.
Possible Values:
interestcontains
interestcontainsall
interestnotcontains
field
Type: String
Title: Interest Group
Read only: false
The interest group, like “interests-123”
value
Type: Array
Title: Segment Value
Read only: false
An array containing integers, each representing a group id.
EcommCategory
Type: Object
Title: Ecomm Category Segment - EcommCategory
Show properties
op
Type: String
Title: Operator
Read only: false
A member who has purchased from a category or purchased a specific item.
Possible Values:
is
not
contains
notcontain
starts
ends
field
Type: String
Title: Ecomm Category or Product
Read only: false
The e-commerce category or product segment field.
value
Type: String
Title: Ecomm Category or Item
Read only: false
The e-commerce category or item information.
EcommNumber
Type: Object
Title: Ecomm Purchased Segment - EcommNumber
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.
field
Type: String
Title: Ecomm Number
Read only: false
The e-commerce number field to segment on.
Possible Values:
ecomm_spent_avg
ecomm_orders
ecomm_prod_all
ecomm_avg_ord
value
Type: Number
Title: Amount Spent
Read only: false
Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.
EcommPurchased
Type: Object
Title: Ecomm Purchased Segment - EcommPurchased
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have have (‘member’) or have not (‘notmember’) purchased.
field
Type: String
Title: Ecomm Purchased
Read only: false
The e-commerce purchased field to segment on.
EcommSpent
Type: Object
Title: Ecomm Purchase Segment - EcommSpent
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have spent more or less than the set value.
field
Type: String
Title: Ecomm Spent
Read only: false
The e-commerce spent field to segment on.
Possible Values:
ecomm_spent_one
ecomm_spent_all
value
Type: Integer
Title: Total Spent
Read only: false
The total amount a member spent.
EcommStore
Type: Object
Title: Ecomm Purchased Store Segment - EcommStore
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have or have not purchased from a specific store.
field
Type: String
Title: Ecomm Store
Read only: false
The e-commerce store field to segment on.
value
Type: String
Title: Store ID
Read only: false
The store id to segment on.
GoalActivity
Type: Object
Title: Goal Activity Segment - GoalActivity
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the website URL is/not exactly, contains/doesn’t contain, starts with/ends with a string.
Possible Values:
is
goal_not
contains
goal_notcontain
starts
ends
field
Type: String
Title: Goal Activity
Read only: false
The goal activity field to segment on.
value
Type: String
Title: Goal URL
Read only: false
The URL to check Goal activity against.
GoalTimestamp
Type: Object
Title: Goal Timestamp Segment - GoalTimestamp
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the website activity happened at, after, or before a specific date.
field
Type: String
Title: Goal Time
Read only: false
The goal time field to segment on.
extra
Type: String
Title: Date
Read only: false
The date for the segment, formatted as YYYY-MM-DD.
value
Type: String
Title: Event Type
Read only: false
What type of data to segment on.
FuzzySegment
Type: Object
Title: Similar Subscribers Segment Member Segment - FuzzySegment
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are/are not apart of a ‘similar subscribers’ segment.
field
Type: String
Title: Fuzzy Segment
Read only: false
The fuzzy segment field.
value
Type: Number
Title: Similar Subscribers Segment ID
Read only: false
The id for the ‘similar subscribers’ segment.
StaticSegment
Type: Object
Title: Static Segment Member Segment - StaticSegment
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are/are not apart of a static segment.
field
Type: String
Title: Static Segment
Read only: false
The static segment field.
value
Type: Number
Title: Static Segment ID
Read only: false
The id for the static segment.
IPGeoCountryState
Type: Object
Title: Location-Based Segment - IPGeoCountryState
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific country or US state.
Possible Values:
ipgeocountry
ipgeonotcountry
ipgeostate
ipgeonotstate
field
Type: String
Title: Country State
Read only: false
The field to segment on.
value
Type: String
Title: Country Code or US State
Read only: false
The two-letter country code or US state abbreviation.
IPGeoIn
Type: Object
Title: Geolocation Segment - IPGeoIn
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific geographic region.
lng
Type: String
Title: Segment Location Longitude
Read only: false
The longitude of the target location.
field
Type: String
Title: Location
Read only: false
The field to segment on.
addr
Type: String
Title: Segment Location Address
Read only: false
The address of the target location.
value
Type: Integer
Title: Target Location Radius
Read only: false
The radius of the target location.
lat
Type: String
Title: Segment Location Latitude
Read only: false
The latitude of the target location.
IPGeoInZip
Type: Object
Title: US Zip Code Segment - IPGeoInZip
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are in a specific US zip code.
field
Type: String
Title: Location in Zip
Read only: false
The field to segment on.
extra
Type: Integer
Title: Zip Code
Read only: false
The zip code to segment on.
value
Type: Integer
Title: Target Location Radius
Read only: false
The radius of the target location.
IPGeoUnknown
Type: Object
Title: Location-Based Segment - IPGeoUnknown
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members with unknown location information.
field
Type: String
Title: Unknown Location
Read only: false
The field to segment on.
IPGeoZip
Type: Object
Title: Location-Based Segment - IPGeoZip
Show properties
op
Type: String
Title: Operator
Read only: false
Segment members who are or are not in a specific US zip code.
field
Type: String
Title: Zip
Read only: false
The field to segment on.
value
Type: Integer
Title: Zip Code
Read only: false
The 5-digit zip code.
SocialAge
Type: Object
Title: Social Profiles Age Segment - SocialAge
Show properties
op
Type: String
Title: Operator
Read only: false
Members who do or don’t match the exact criteria listed.
field
Type: String
Title: Social Age
Read only: false
The social age field to segment on.
value
Type: String
Title: Age Range
Read only: false
The age range to segment.
SocialGender
Type: Object
Title: Social Profiles Gender Segment - SocialGender
Show properties
op
Type: String
Title: Operator
Read only: false
Members who do or don’t match the exact criteria listed.
field
Type: String
Title: Social Gender
Read only: false
The social gender field to segment on.
value
Type: String
Title: Social Gender
Read only: false
The Social Profiles gender to segment.
SocialInfluence
Type: Object
Title: Social Profiles Influence Segment - SocialInfluence
Show properties
op
Type: String
Title: Operator
Read only: false
Members who have a rating that is/not or greater/less than the rating provided.
field
Type: String
Title: Social Influence
Read only: false
The social influence field to segment on.
value
Type: Number
Title: Influence Rating
Read only: false
The Social Profiles influence rating to segment on.
SocialNetworkMember
Type: Object
Title: Social Profiles Social Network Segment - SocialNetworkMember
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are or are not on a specific social network.
field
Type: String
Title: Social Network
Read only: false
The social_network segment field.
value
Type: String
Title: Social Network
Read only: false
The social network to segment on.
Possible Values:
twitter
facebook
linkedin
flickr
foursquare
lastfm
myspace
quora
vimeo
yelp
youtube
SocialNetworkFollow
Type: Object
Title: Social Profiles Social Network Follow Segment - SocialNetworkFollow
Show properties
op
Type: String
Title: Operator
Read only: false
Members who are or are not following a linked account on a specific social network.
field
Type: String
Title: Social Network Follow
Read only: false
The field to segment on.
value
Type: String
Title: Social Network
Read only: false
The social network to segment on.
AddressMerge
Type: Object
Title: Address/Zip Merge Field Segment - AddressMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value contains, doesn’t contain, is blank, or isn’t blank.
Possible Values:
contains
notcontain
blank
blank_not
field
Type: String
Title: Address Merge
Read only: false
The address merge segment field.
value
Type: String
Title: Address Merge Compare Value
Read only: false
The value to compare.
ZipMerge
Type: Object
Title: Address/Zip Merge Field Segment - ZipMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the zip value is in a specific location.
field
Type: String
Title: Zip Merge
Read only: false
The zip merge segment field.
extra
Type: String
Title: City or Zip
Read only: false
The city or the zip being used to segment on.
value
Type: String
Title: Zip Merge Compare Value
Read only: false
The value to compare.
BirthdayMerge
Type: Object
Title: Birthday Merge Field Segment - BirthdayMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
field
Type: String
Title: Birthday Merge
Read only: false
The birthday merge segment field.
value
Type: String
Title: Birthday Merge Compare Value
Read only: false
The value to compare.
DateMerge
Type: Object
Title: Date Merge Field Segment - DateMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
Possible Values:
is
not
less
blank
blank_not
field
Type: String
Title: Date Merge
Read only: false
The date merge segment field.
value
Type: String
Title: Date Merge Compare Value
Read only: false
The value to compare.
TextMerge
Type: Object
Title: Text or Number Merge Field Segment - TextMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
Possible Values:
is
not
contains
notcontain
starts
ends
greater
less
blank
blank_not
field
Type: String
Title: Text Merge
Read only: false
The segment field, one of ‘merge0’ or ‘EMAIL’.
value
Type: String
Title: Text Merge Compare Value
Read only: false
The value to compare.
SelectMerge
Type: Object
Title: Dropdown/Radio Merge Field Segment - SelectMerge
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the segment value matches exactly, doesn’t match, is blank, or isn’t blank.
field
Type: String
Title: Select
Read only: false
The select merge segment field.
value
Type: String
Title: Select Merge Compare Value
Read only: false
The value to compare.
EmailAddress
Type: Object
Title: Email Segment - EmailAddress
Show properties
op
Type: String
Title: Operator
Read only: false
Whether the email address is/not exactly, contains/doesn’t contain, starts/ends with a string.
Possible Values:
is
not
contains
notcontain
starts
ends
greater
less
field
Type: String
Title: Email
Read only: false
The segment field, one of ‘merge0’ or ‘EMAIL’.
value
Type: String
Title: Email Compare Value
Read only: false
The value to compare the email against.
PredictedAge
Type: Object
Title: Segment Condition - PredictedAge
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
PredictedGender
Type: Object
Title: Segment Condition - PredictedGender
Show properties
op
Type: String
Title: Segment Operator
Read only: false
The segment operator.
field
Type: String
Title: Segment Field
Read only: false
The field to segment on.
thumbnail
Type: String
Title: No Title
Read only: false
The URL of the thumbnail for this outreach
email_source_name
Type: String
Title: No Title
Read only: false
No Description
paused_at
Type: String
Title: No Title
Read only: false
No Description
end_time
Type: String
Title: No Title
Read only: false
No Description
needs_attention
Type: Boolean
Title: No Title
Read only: false
No Description
was_canceled_by_facebook
Type: Boolean
Title: No Title
Read only: false
No Description
is_connected
Type: Boolean
Title: No Title
Read only: false
Check if this ad is connected to a facebook page
has_audience
Type: Boolean
Title: No Title
Read only: false
Check if this ad has audience setup
has_content
Type: Boolean
Title: No Title
Read only: false
Check if this ad has content
channel
Type: Object
Title: No Title
Read only: false
Channel settings
Show properties
fb_placement_feed
Type: Boolean
Title: No Title
Read only: false
Is this for facebook feed
fb_placement_audience
Type: Boolean
Title: No Title
Read only: false
Is this for facebook audience
ig_placement_feed
Type: Boolean
Title: No Title
Read only: false
Is this for instagram feed
feedback
Type: Object
Title: No Title
Read only: false
Check if this ad is connected to a facebook page
Show properties
content
Type: String
Title: No Title
Read only: false
Feedback regarding the content of this Ad.
audience
Type: String
Title: No Title
Read only: false
Feedback regarding the audience of this Ad.
budget
Type: String
Title: No Title
Read only: false
Feedback regarding the budget of this Ad.
compliance
Type: String
Title: No Title
Read only: false
Feedback regarding the compliance of this Ad.
audience
Type: Object
Title: No Title
Read only: false
Audience settings
Show properties
type
Type: String
Title: No Title
Read only: false
Type of the audience
Possible Values:
Custom Audience
Lookalike Audience
Interest-based Audience
source_type
Type: String
Title: No Title
Read only: false
List or Facebook based audience
email_source
Type: Object
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
Email source name
type
Type: String
Title: No Title
Read only: false
Type of the email source
is_segment
Type: Boolean
Title: No Title
Read only: false
Is the source reference a segment
segment_type
Type: String
Title: No Title
Read only: false
Segment type if this source is tied to a segment
list_name
Type: String
Title: No Title
Read only: false
Associated list name to the source
include_source_in_target
Type: Boolean
Title: No Title
Read only: false
To include list contacts as part of audience
lookalike_country_code
Type: String
Title: No Title
Read only: false
To find similar audience in given country
targeting_specs
Type: Object
Title: No Title
Read only: false
No Description
Show properties
gender
Type: Integer
Title: No Title
Read only: false
No Description
min_age
Type: Integer
Title: No Title
Read only: false
No Description
max_age
Type: Integer
Title: No Title
Read only: false
No Description
locations
Type: Object
Title: No Title
Read only: false
No Description
Show properties
countries
Type: Array
Title: No Title
Read only: false
No Description
regions
Type: Array
Title: No Title
Read only: false
No Description
cities
Type: Array
Title: No Title
Read only: false
No Description
zips
Type: Array
Title: No Title
Read only: false
No Description
interests
Type: Array
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
No Description
budget
Type: Object
Title: No Title
Read only: false
No Description
Show properties
duration
Type: Integer
Title: No Title
Read only: false
Duration of the ad in seconds
total_amount
Type: Number
Title: No Title
Read only: false
Total budget of the ad
currency_code
Type: String
Title: No Title
Read only: false
Currency code
content
Type: Object
Title: No Title
Read only: false
No Description
Show properties
title
Type: String
Title: No Title
Read only: false
No Description
link_url
Type: String
Title: No Title
Read only: false
No Description
message
Type: String
Title: No Title
Read only: false
No Description
description
Type: String
Title: No Title
Read only: false
No Description
image_url
Type: String
Title: No Title
Read only: false
No Description
call_to_action
Type: String
Title: No Title
Read only: false
No Description
attachments
Type: Array
Title: No Title
Read only: false
No Description
Show properties
name
Type: String
Title: No Title
Read only: false
No Description
link_url
Type: String
Title: No Title
Read only: false
No Description
description
Type: String
Title: No Title
Read only: false
No Description
image_url
Type: String
Title: No Title
Read only: false
No Description
call_to_action
Type: String
Title: No Title
Read only: false
No Description
_links
Type: Array
Title: Links
Read only: true
A list of link types and descriptions for the API schema documents.
Show properties
rel
Type: String
Title: Rel
Read only: true
As with an HTML ‘rel’ attribute, this describes the type of link.
href
Type: String
Title: Href
Read only: true
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
method
Type: String
Title: Method
Read only: true
The HTTP method that should be used when accessing the URL defined in ‘href’.
Possible Values:
GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD
targetSchema
Type: String
Title: Target Schema
Read only: true
For GETs, this is a URL representing the schema that the response should conform to.
schema
Type: String
Title: Schema
Read only: true
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
Error response
type
Type: String
Title: Problem Type
Read only: false
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
title
Type: String
Title: Error Title
Read only: false
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
status
Type: Integer
Title: HTTP Status Code
Read only: false
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
detail
Type: String
Title: Error Message
Read only: false
A human-readable explanation specific to this occurrence of the problem. Learn more about errors .
instance
Type: String
Title: Instance ID
Read only: false
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.