Facebook AdsNot a big fan of functions?
Use the Actions Wizard to configure any action in Rows without functions.
Parameter List
Syntax
GET_ADSET_METRICS_FACEBOOK_ADS(account_name,
[adset_name]
, [metrics]
, [breakdowns]
, [date_range]
, [aggregation_period]
)account_name
Name or ID of your Facebook Ads account. For example: "Personal Ads account".
[optional] adset_name
Name or ID of your ad set. For example: "Performance in Germany". Don't configure this field if you wish to retrieve metrics from all Ad Sets of your account.
[optional] metrics
Range of metrics to retrieve about the ad account. For example: '["clicks","country"]'. By default, it returns the most common metrics about the ad account. For a complete list of possible fields, see the Facebook Marketing API documentation.
Selected options:
Account Currency
Account ID
Account Name
All Conversions
Adset ID
Adset Name
Age Targeting
Auction Bid
Auction Competitiveness
Buying Type
Campaign ID
Campaign Name
Canvas Average View Percent
Canvas Average View Time
Clicks
Cost - Location Searches
Cost - Messaging Conversations Started (Onsite Conversion)
Cost - Messaging Subscriptions (Onsite Conversion)
Cost - Mobile App Achievements
Cost - Mobile App Adds To Cart
Cost - Mobile App Adds to Wishlist
Cost - Mobile App Applications Submitted
Cost - Mobile App Appointments Scheduled
Cost - Mobile App Canceled Subscriptions
Cost - Mobile App Checkouts
Cost - Mobile App Contacts
Cost - Mobile App Content Views
Cost - Mobile App Credit Spends
Cost - Mobile App Donations
Cost - Mobile App Feature Unlocks
Cost - Mobile App Installs
Cost - Mobile App Location Searches
Cost - Mobile App Payment Details
Cost - Mobile App Products Customized
Cost - Mobile App Purchases
Cost - Mobile App Ratings
Cost - Mobile App Recurring Subscription Payments
Cost - Mobile App Registrations
Cost - Mobile App Searchs
Cost - Mobile App Starts
Cost - Mobile App Subscriptions
Cost - Mobile App Trials Started
Cost - Mobile App Tutorial Completions
Cost - New Messaging Conversations (Onsite Conversion)
Cost - Offline App Appointments Scheduled
Cost - Offline Applications Submitted
Cost - Offline App Location Searches
Cost - Offline Canceled Subscriptions
Cost - Offline Contacts
Cost - Offline Donations
Cost - Offline Products Customized
Cost - Offline Recurring Subscription Payments
Cost - Offline Subscriptions
Cost - Offline Trials Started
Cost - On Facebook Applications Submitted
Cost - On Facebook Donations
Cost - On-Facebook Purchases (Onsite Conversion)
Cost - On-Facebook Workflow Completions (Offsite Conversion)
Cost - Other Mobile App Actions
Cost - Outbound Clicks
Cost - Page Engagement
Cost - Page Likes
Cost - Page Photo Views
Cost Per Inline Link Click
Cost Per Inline Post Engagement
Cost Per Unique Inline Link Click
Cost - Post Comments
Cost - Post Engagement
Cost - Post Reactions
Cost - Post Saves (Onsite Conversion)
Cost - Post Shares
Cost - Products Customized
Cost - Purchases (Offsite Conversion)
Cost - Purchases (Omnichannel)
Cost - Ratings Submitted (Omnichannel)
Cost - Recurring Subscription Payments
Cost - Registrations Completed (Omnichannel)
Cost - Searches (Omnichannel)
Cost - Searchs (Offsite Conversion)
Cost - Subscriptions
Cost - Trials Started
Cost - Tutorials Completed (Omnichannel)
Cost - Views Content (Offsite Conversion)
Cost - Website Applications Submitted
Cost - Website Appointments Scheduled
Cost - Website Canceled Subscriptions
Cost - Website Contacts
Cost - Website Donations
Cost - Website Location Searches
Cost - Website Products Customized
Cost - Website Recurring Subscription Payments
Cost - Website Subscriptions
Cost - Website Trials Started
Country
CPC
CPM
CPP
Created Time
CTR
Date From
Date To
Device Platform
DMA
Frequency
Frequency Value
Full View Impressions
Full View Reach
Gender Targeting
Hourly Stats Aggregated By Advertiser Time Zone
Hourly Stats Aggregated By Audience Time Zone
Impressions
Inline Link Click CTR
Inline Link Clicks
Inline Post Engagement
Location
Location Searches
Messaging Conversations Started (Onsite Conversion)
Messaging Subscriptions (Onsite Conversion)
Mobile App Achievements
Mobile App Adds To Cart
Mobile App Adds to Wishlist
Mobile App Applications Submitted
Mobile App Appointments Scheduled
Mobile App Canceled Subscriptions
Mobile App Checkouts
Mobile App Contacts
Mobile App Content Views
Mobile App Credit Spends
Mobile App Donations
Mobile App Feature Unlocks
Mobile App Installs
Mobile App Location Searches
Mobile App Payment Details
Mobile App Products Customized
Mobile App Purchases
Mobile App Ratings
Mobile App Recurring Subscription Payments
Mobile App Registrations
Mobile App Searchs
Mobile App Starts
Mobile App Subscriptions
Mobile App Trials Started
Mobile App Tutorial Completions
Mobile Purchase ROAS
Mobile Purchase ROAS
New Messaging Conversations (Onsite Conversion)
Objective
Objective
Offline App Appointments Scheduled
Offline Applications Submitted
Offline App Location Searches
Offline Canceled Subscriptions
Offline Contacts
Offline Donations
Offline Products Customized
Offline Recurring Subscription Payments
Offline Subscriptions
Offline Trials Started
On Facebook Applications Submitted
On Facebook Donations
On-Facebook Purchases (Onsite Conversion)
On-Facebook Workflow Completions (Offsite Conversion)
Optimization Goal
Optimization Goal
Other Mobile App Actions
Outbound Clicks
Page Engagement
Page Likes
Page Photo Views
Place Page ID
Place Page ID
Place Page Name
Place Page Name
Post Comments
Post Engagement
Post Reactions
Post Saves (Onsite Conversion)
Post Shares
Product ID
Product ID
Products Customized
Publisher Platform
Publisher Platform
Purchase ROAS
Purchase ROAS
Purchases (Offsite Conversion)
Purchases (Omnichannel)
Ratings Submitted (Omnichannel)
Reach
Reach
Recurring Subscription Payments
Registrations Completed (Omnichannel)
Searches (Omnichannel)
Searchs (Offsite Conversion)
Social Spend
Social Spend
Spend
Spend
Subscriptions
Trials Started
Tutorials Completed (Omnichannel)
Updated Time
Updated Time
Views Content (Offsite Conversion)
Website Applications Submitted
Website Appointments Scheduled
Website Canceled Subscriptions
Website Contacts
Website Donations
Website Location Searches
Website Products Customized
Website Purchase ROAS
Website Purchase ROAS
Website Recurring Subscription Payments
Website Subscriptions
Website Trials Started
Wish Bid
[optional] breakdowns
Range of values to break down the results into different sets. For example: '["device_platform"]'. For a complete list of possible breakdowns, see the Facebook Insights API Breakdowns documentation.
Selected options:
Ad Format Asset
Age
App ID
Body Asset
Call_to_action Asset
Country
Description Asset
Gender
Image Asset
Impression Device
Link_url Asset
Product ID
Region
Skan Conversion ID
Title Asset
Video Asset
DMA
Frequency Value
Hourly Stats Aggregated by advertiser time zone
Hourly Stats Aggregated by audience time zone
Place Page ID
Publisher Platform
Platform Position
Device Platform
[optional] date_range
Date range to get insights for. For example: ">2019", ">2019-11-01" or "[2010-01-01;2019-01-01]". By default, you get insights for the current month.
[optional] aggregation_period
Groups the ad set insights by time period. By default, it will group the ad set stats for the whole period. 1 breaks down that data by day,7 by week and monthly by calendar month.
Selected options:
daily
weekly
monthly