This page provides a guide to Establishing a Connection to Facebook Ads in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Facebook Ads

Establishing a Connection shows how to authenticate to Facebook Ads and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Facebook Ads through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Facebook Ads by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Facebook Ads

The following are optional connection properties:

• Target: Some Facebook tables can be filtered by a target. For example, to retrieve comments on a video, specify the Id of the video as the target. This property enables you to restrict the results of all queries in the connection to records that match the specified target. You can also specify this restriction per query with the Target column.
• AggregateFormat: The Cloud returns some columns as a string aggregate. For example, the available likes data for an entity is returned in aggregate. By default, the Cloud returns aggregate columns in JSON. You can also return aggregates in XML.
• RetryLevel: Use this property to control automatic query retry for specific ad insights queries and errors.

Authenticating to Facebook Ads

Facebook Ads uses the OAuth standard to authenticate users.

OAuth

[

Requesting Additional Permissions

You may find while using the Cloud that Facebook returns an error stating your app does not have permissions to do a certain action. To resolve this, you must generate a new OAuth access token with the required permissions. Set the Scope property in the authentication step. You can find a list of available Facebook permissions here:

http://developers.facebook.com/docs/authentication/permissions/

Note that in some cases, permissions restrictions might not be due to missing but requestable Facebook Ads OAuth permissions, but instead might be due to missing OAuth app features, like Page Public Content Access or Page Public Metadata Access. These features are tied to the OAuth app as a whole, and cannot be approved or denied for individual OAuth access tokens requested by users. Consider Creating a Custom OAuth App if you need access to app features not available with the embedded OAuth app.

AuthenticateAsPage Property

Use the AuthenticateAsPage connection property if you want to post as a single page. To query collections of pages, leave AuthenticateAsPage blank, in which case CData tools automatically detect which page tokens to use. Alternatively, if you would like to disable this automatic detection and thus require usage of AuthenticateAsPage when querying a page, set AutoDetectPageTokens to "False".

The following sections compare the two options.

Posting as a Page

After authenticating to Facebook Ads with your user account, you can post, etc. as one of the pages you manage: Set the AuthenticateAsPage property to the Id of the page you want. You can find the Ids for all pages your account has access to by querying the Pages view.

Automatic Page

Facebook Ads has made a number of recent changes that require page tokens for most resources owned by a page. This can be troublesome if you manage multiple pages and want to execute the same queries across all pages (such as retrieving Insights). In order to make this work seamlessly with our tools, we have added a way to automatically detect the page token to use. For this to work, simply do not specify the AuthenticateAsPage and leave AutoDetectPageTokens set to "True". Note that the correct page token can only be resolved if the page id is specified as part of the target in the request. This means for some requests you will still need to manually specify AuthenticateAsPage.

Setting AutoDetectPageTokens to "False" will disable automatic page token detection.

Fine Tuning Data Access

You can use the following properties to gain greater control over Facebook Ads API features and the strategies the Cloud uses to surface them:

• AccountID: Set this to specify an ad account ID that will be used for the Target input for queries if none is specified. Both Target connection property and Target query input have precedence over this property.
• RetryLevel: Use this property to control query retry for certain types of ad insights queries and errors. Please see the pages for AdInsights and AdInsightsActions views in Data Model for more information.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models Facebook Ads APIs as relational Tables, Views, and Stored Procedures. The Cloud uses the Facebook Ads API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Views

Views describes the available views. Two types of views are made available:

• Base Views are statically defined to model Ad Accounts, Campaigns, Businesses, Lead Values, and more. They are used to create your custom reports instead of being used standalone. By default. these views return data from all time aggregated into a single row.
• Predefined Report Views are a set of standard reports that mimic exactly what you see in the Facebook UI. All Predefined Report Views have "report" appended to their name. By default, these views return data from all time with a daily breakdown.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Querying Facebook Ads Data

The Cloud supports filtering Facebook Ads views in several unique ways, such as by ad level, breakdown, time range, action collection, or action attribution. Also, many views require a target to be specified in queries. See Querying Facebook Ads Data for more information.

Insight Reports

The Cloud offers a selection of pre-built report views representing common reporting scenarios. Queries to these views are simpler than queries to AdInsights and AdInsightsActions. This is because querying each report view is equivalent to a more complex query containing the breakdowns and action collections associated with that reporting scenario, removing the need to specify them manually.

See Using Pre-Built Reports for a list of these pre-built reports, as well as instructions for defining additional report views.

The ad data for Facebook Ads is represented and accessed through several tables and views exposed by the Cloud. There are a couple of general rules, presented below, for querying these tables and views.

See the pages for individual tables or views for additional details related to querying them.

Specifying a Target

For many views related to ads, a target must be specified when querying them in order to identify the specific ad or account object for which data should be retrieved. For example, when querying the Ads view, the Target column must be specificed as a criteria pointing to a specific ad account:

SELECT * FROM Ads WHERE Target = 'act_123456'

A Target can also be specified dynamically in a query:

SELECT * FROM Ads WHERE Target IN (SELECT ID FROM AdAccounts)

If no Target is specified in a query, and the Target connection property is not set, the AccountID connection property will be used to determine the default target for ads queries. If none of these are set, the first account id returned from Facebook Ads will be used.

Insights Views

Analytics, peformance, and reporting data for ads is accessed through the AdInsights and AdInsightsActions views. Queries to these views will require a Target as covered in the previous section, but also support more detailed query syntax for their reporting functionality.

Time Ranges

When trying to pull ad reporting and analytics, use DateStart and DateEnd or DatePreset in your query to control the time range of ads data.

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset='last_90d' AND TimeIncrement='monthly'

When specifying a time range for ads data, use TimeIncrement to control the time span of ad data summarized in each result row. For example, if TimeIncrement is set to "monthly", each result row will correspond to a monthly roll-up of ad data.

Ad levels

The Target specified for a query will control what ad account ad data is retrieved for. Use Level to control what level of ad object results are reported at. Level can be set to ad, adset, campaign, or account.

Breakdowns

Facebook Ads offers a number of breakdowns for querying your ad insights data. These breakdowns are exposed and can be used through the AdInsights and AdInsightsActions views, such that each row returned for a query will correspond to the reporting data for one combination of the breakdowns specified in the query. The aggregated data returned for a breakdown combo will still be limited by the ad object target and ad object level specified in the query.

Facebook Ads does enforce restrictions on what breakdowns can be selected together, so by default the Cloud also enforces similar restrictions on breakdowns in queries supplied to it. If desired, this internal enforcement can be disabled through the IgnoreValidationException property. Setting this property to "True" bypasses internal enforcement of breakdown restrictions, and passes any supplied breakdown combination as-is to Facebook.

Please see Data Model for more info on breakdown combos.

Action Collections

The AdInsightsActions view also offers an ActionCollection column, which allows you to specify what sort of actions attributed to your ads you would like to look at.

Action Attributions

The AdInsightsActions view also offers an ActionAttributionWindows column, which allows you to control how Facebook Ads attributes actions to your ad object when it generates its report. ActionAttributionWindows are specified from a list of combinations that define action and time period combinations. For example, the default value for ActionAttributionWindows is "7d_click,1d_view", meaning that relevant actions taken within 7 days of clicking on your ad object or 1 day of viewing it are attributed to and reported on for the ad object.

There are a number of ways that you can query Facebook Ads to get ad insights data, and the AdInsights and AdInsightsActions views facilitate all of these querying methods. For a simplified datamodel and querying experience, we also offer alternatives: you can use pre-built, simplified reports that correspond to queries that you would write for AdInsights or AdInsightsActions, or you can define your own ad insights report with the CreateAdInsightsReport stored procedure.

Using the Pre-Built Reports

The driver contains the following pre-built reports:

• AdInsights_ByActionReaction_90DayIncr
• AdInsights_ByAge_90DayIncr
• AdInsights_ByAgeAndGender_90DayIncr
• AdInsights_ByCarousel_90DayIncr
• AdInsights_ByCountry_90DayIncr
• AdInsights_ByDevicePlatform_90DayIncr
• AdInsights_ByDMA_90DayIncr
• AdInsights_ByGender_90DayIncr
• AdInsights_ByProductId_90DayIncr
• AdInsights_ByPublisherPlatform_90DayIncr
• AdInsights_ByRegion_90DayIncr
• AdInsights_ByVideoSound_90DayIncr
• AdInsights_ByVideoType_90DayIncr
• AdInsights_TargetedLevel_90DayIncr

Queries to these views are simpler than queries to AdInsights and AdInsightsActions in that these views already define the breakdowns and action collections to query. Queries to these views still require the specification of a Target ad object, however, and can also still use the Level and ActionAttributionWindows filters.

SELECT * FROM AdInsights_ByActionReaction_90DayIncr WHERE Target='act_12345' AND Level='adset'

The naming scheme for the views defines the breakdowns queried by the view, and the default time increment used by the view. The views will attempt to query ads data as far back in time as possible. The time span and time increment for the default views can be changed by query inputs.

Defining Custom Reports with CreateAdInsightsReport

If you routinely need to request fields that are not available on the pre-built reports that ship with the Cloud, or you want to create a simpler ad report for your users, you may want to define your own custom ads report so that you can more easily query for the data you need. The CreateAdInsightsReport stored procedure can be used for this purpose.

The stored procedure outputs schema files, depdending on the output options supplied. Set the Location connection property to the output path of the generated reports to expose them as queryable tables in the Cloud.

The example stored procedure call below creates a custom ad insights report with the specified fields, breakdowns, action breakdowns, and action collections:

EXEC CreateAdInsightsReport @ReportName = 'AdInsights_CreatedReport', @Fields = 'AccountCurrency,AdAccountId', @Breakdowns = 'Country', @ActionBreakdowns='ActionType,ActionDestination',@ActionCollection='Actions,UniqueActions', @OutputDirectory='LOCATION'"

In this example, the @OutputDirectory parameter is set to the location specified for the Location connection property.

The Cloud models the data in Facebook Ads as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Facebook Ads Tables

Name	Description
CustomAudiences	Query information about custom audiences defined for your ad accounts.
CustomConversions	Query information about custom conversions defined for your ad accounts.

Query information about custom audiences defined for your ad accounts.

Table Specific Information

Custom audiences in Facebook Ads represent an advertiser-defined audience to deliver ads to.

SELECT

The ExternalEventSource column is not returned by default, as it requires additional permissions for the underlying AdPixels object. To retrieve information for this column, it should be set in the query projection explicitly:

SELECT Id, Name, ExternalEventSource FROM CustomAudiences

Note: Listing CustomAudiences while selecting ExternalEventSource will only return CustomAudiences where the currently authenticated app has access to the underlying AdsPixel object.

Insert

When inserting CustomAudiences, at least a Name, Subtype, and CustomerFileSource must be specified:

INSERT INTO CustomAudiences (Name, Subtype, CustomerFileSource) VALUES ('Custom Audience', 'CUSTOM', 'USER_PROVIDED_ONLY')

Note: To insert users to a Custom Audience, the AddCustomAudienceUsers stored procedure must be used.

Delete

When deleting CustomAudiences, the Id of the object should be specified.

DELETE FROM CustomAudiences WHERE Id='123456'

Note: To delete users from a Custom Audience, the DeleteCustomAudienceUsers stored procedure must be used.

Columns

Name	Type	ReadOnly	Description
ID [KEY]	String	True	The ID of the custom audience.
Account_ID	String	True	The ID of the custom audience's ad account.
Name	String	False	The name of the custom audience.
Description	String	False	The description of the custom audience.
Subtype	String	False	The subtype of the custom audience. Valid values are: CUSTOM, PRIMARY, WEBSITE, APP, OFFLINE_CONVERSION, CLAIM, MANAGED, PARTNER, VIDEO, LOOKALIKE, ENGAGEMENT, BAG_OF_ACCOUNTS, STUDY_RULE_AUDIENCE, FOX, MEASUREMENT, REGULATED_CATEGORIES_AUDIENCE, BIDDING, SUBSCRIBER_SEGMENT, EXCLUSION
TimeCreated	Datetime	True	Creation time of the custom audience.
TimeUpdated	Datetime	True	Last updated time of the custom audience.
TimeContentUpdated	Datetime	True	Last update of people in this custom audience. Only supported for Customer List Custom Audiences.
Rule	String	False	Audience rules to be applied on the referrer URL.
RuleAggregation	String	False	Aggregation on top of the audience rule.
ApproximateCountLowerBound	Integer	True	Lower bound of the approximate number of people in this audience.
ApproximateCountUpperBound	Integer	True	Upper bound of the approximate number of people in this audience.
PixelID	String	False	ID of pixel which is collecting events for Website Custom audience.
RetentionDays	Integer	False	Number of days to retain user in this audience. Can be any value between 1 and 180 days. Defaults to forever if left unspecified. Only available for Customer File Custom Audience.
CustomerFileSource	String	False	Source of customer information in the uploaded file.
DataSource	String	True	JSON dictionary to indicate the method by which the custom audience was created.
DeliveryStatus	String	True	JSON dictionary which indicates whether an audience can be used in ads.
ExternalEventSource	String	True	JSON dictionary containing the pixel id whose traffic generated the custom audience.
OperationStatus	String	True	JSON dictionary containing status code and description of last operation.
PermissionForActions	String	True	JSON dictionary of permissions (string) to boolean value if the custom audience has that permission.
IsValueBased	Boolean	False	Whether the audience is used to seed value based lookalike.
OptOutLink	String	False	Opt-out URL for audience members who choose not to be targeted.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name	Type	Description
EnableFetchOrCreate	Boolean	When set to true during INSERT, this parameter causes any identical custom audience to be fetched. Prevents INSERT of duplicate audience.
UseInCampaigns	Boolean	Controls whether this custom audience will be used in campaigns. Defaults to true.
Prefill	Boolean	If true, website traffic recorded prior to audience creation will be used to initialize this audience. If false, only website traffic garnered after the creation of this audience will be used.
DatasetId	Integer	ID of offline conversion dataset associated with this audience.
ContentType	String	Specifies content type for TRAVEL claim objective. Mandatory if creating audience with TRAVEL claim objective. Valid values are: AUTOMOTIVE_MODEL, DESTINATION, FLIGHT, GENERIC, HOME_LISTING, HOTEL, JOB, LOCAL_SERVICE_BUSINESS, MEDIA_TITLE, OFFLINE_PRODUCT, PRODUCT, VEHICLE, VEHICLE_OFFER
ClaimObjective	String	Specifies objective of audiences with CLAIM subtype. Valid values are: AUTOMOTIVE_MODEL, COLLABORATIVE_ADS, HOME_LISTING, MEDIA_TITLE, PRODUCT, TRAVEL, VEHICLE, VEHICLE_OFFER.
EventSourceGroup	Integer	Specifies event source group if using TRAVEL claim objective.
ProductSetId	Integer	Id of the Product Set to target with this audience.
OriginAudienceId	Integer	Id of origin Custom Audience. Origin audience must have a minimum size of 100.

Query information about custom conversions defined for your ad accounts.

Table Specific Information

Custom conversions in Facebook represent conversion events to optimize ad delivery.

Insert

When inserting CustomConversions, at least a name must be specified:

INSERT INTO CustomConversions (Name) VALUES ('TestConversion')

If inserting to the Rule or AdvancedRule columns, the rule configuration should be specified as a JSON aggregate:

INSERT INTO CustomConversions (Name, EventSourceId, Rule, CustomEventType) 
VALUES 
 ('test',
 '871481174114636',
 '{"and":[{"event":{"eq": "Purchase"}},{"value":{"gt":100}}]}',
 'PURCHASE')

See the Facebook Marketing API documentation on CustomConversions for all available Rule configurations.

Update

When updating CustomConversions, the ID of the object must be specified in the WHERE clause:

UPDATE CustomConversions SET Name='test1' WHERE ID='123abc'

Note: The Facebook Marketing API only supports updates on the DefaultConversionValue, Name, and Description columns.

Delete

When deleting CustomConversions, the Id of the object should be specified:

DELETE FROM CustomConversions WHERE ID='123abc'

Columns

Name	Type	ReadOnly	Description
ID [KEY]	String	True	The ID of the custom conversion
Account_ID	String	True	The ID of the custom conversion's ad account
BusinessID	String	True	ID of business that owns the custom conversion
BusinessName	String	True	Name of business that owns the custom conversion
CreationTime	Datetime	True	Time at which the conversion was created
CustomEventType	String	False	The type of the conversion event The allowed values are ADD_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, COMPLETE_REGISTRATION, CONTENT_VIEW, INITIATED_CHECKOUT, LEAD, PURCHASE, SEARCH, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, LISTING_INTERACTION, FACEBOOK_SELECTED, OTHER.
DataSourcesId	String	True	ID for event sources of the custom conversion
DataSourcesName	String	True	Name for event sources of the custom conversion
DataSourcesSourceType	String	True	Source type for event sources of the custom conversion
DefaultConversionValue	Decimal	False	When conversion is URL based, the default conversion value associated to each conversion
Description	String	False	Description of the custom conversion
EventSourceType	String	True	Event source type of the custom conversion, e.g. pixel, app, etc.
FirstTimeFired	Datetime	True	Time at which the pixel was first fired
IsArchived	Boolean	True	Whether this conversion is archived. Archived conversions are no longer tracked in the system.
IsUnavailable	Boolean	True	Whether this conversion is unavailable
LastFiredTime	Datetime	True	Time at which the pixel was last fired
Name	String	False	Name of the custom conversion
OfflineConversionDataSet	String	True	The offline event set that contains events
PixelID	String	True	ID of the pixel that will send events
RetentionDays	Integer	True	Retention period for advanced rule
Rule	String	False	Rule of the custom conversion

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name	Type	Description
EventSourceId	String	Event source Id.
AdvancedRule	String	Advanced ruleset for the custom conversion being created allowing multiple sources.
ActionSourceType	String	Action source type the custom conversion is created from. The allowed values are app, chat, email, other, phone_call, physical_store, system_generated, website, business_messaging.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Facebook Ads Views

Name	Description
Action_Canvas_Component_Report	Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.
Action_Carousel_Card_Report	Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.
Action_Conversion_Device_Report	Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.
Action_Product_Id_Report	Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.
Action_Reactions_Report	Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.
Action_Video_Sound_Report	Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.
Action_Video_View_Type_Report	Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.
AdAccounts	Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.
AdCreatives	Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.
AdImages	Images associated with an ad account
AdInsights	Queries an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsActions	Query an Ad Report. Accessing Ad Report information requires the ads_read permission.
AdInsightsAssets	Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.
AdLabels	Query information about ad labels. Accessing Ad Information requires the ads_read permission.
Ads	Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission.
AdSets	Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission.
Albums	Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.
AuthorizedAdAccounts	Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id.
Basic_Ad_Report	Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Ad_Set_Report	Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_All_Levels_Report	Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Basic_Campaign_Report	Ad Report focused on ads and providing information on parent campaigns and ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.
Businesses	Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.
Campaigns	Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.
Delivery_Device_Report	Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_And_Device_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Platform_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Delivery_Purchase_Roas_Report	Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_And_Gender_Report	Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Age_Report	Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_Country_Report	Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.
Demographic_DMA_Region_Report	Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.
Demographic_Gender_Report	Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.
Demographic_Region_Report	Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.
LeadValues	Query information about a lead. Accessing Lead Information requires the ads_read permission.
Pages	Query the Pages based on the supplied Id.
Permissions	Query the Permissions the User has granted the current application.

Ad Report focusing on clicks and ROAS, broken down by canvas component. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionCanvasComponentName	String	Name of a component within a Canvas ad.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on clicks and ROAS, broken down by carousel. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionCarouselCardId	String	The ID of the specific carousel card that people engaged with when they saw your ad.
ActionCarouselCardName	String	The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on clicks and ROAS, broken down by serving device and conversion device. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionDevice	String	The device on which the conversion event you are tracking occurred.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on clicks and ROAS, broken down by product id. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
AdId	String	The Id of the Ad associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ProductId	String	The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on clicks and ROAS, broken down by reactions. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
AdId	String	The Id of the Ad associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: ActionValues, MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
ActionReaction	String	The number of reactions on your ads or boosted posts.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on video consumption, broken down by sound status. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: Video30SecWatchedActions, VideoAvgTimeWatchedActions, VideoP100WatchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoThruplayWatchedActions
ActionVideoSound	String	The sound status (on/off) when user watches your video ad.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focusing on video consumption, broken down by video type. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionValue	Integer	Metric value of default attribution window.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
ActionCollection	String	The action collection to retrieve. The available values are: Video30SecWatchedActions, VideoAvgTimeWatchedActions, VideoP100WatchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoThruplayWatchedActions
ActionVideoType	String	Video metrics breakdown.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Query the Ad Accounts available for a User. Accessing Ad Account information requires the ads_read permission.

Table Specific Information

AdAccounts in Facebook are the accounts you have available in Facebook for creating Ads on. The Ids for them are always returned in the format "act_" and when they are used as a Target in requests for other tables, the Id with the prefix "act_" must always be used.

Select

When querying AdAccounts, the Id or Target can be used to filter results. For instance:

SELECT * FROM AdAccounts WHERE Id = 'act_123456'

If you use Facebook Business Manager and manage AdAccounts for clients, all of the ad account ids your business has access to can be listed like so:

SELECT Id FROM AdAccounts WHERE Target IN (SELECT Id FROM Businesses)

Otherwise if Id is not specified, the accounts available for your user account will be listed.

Columns

Name	Type	Description
ID [KEY]	String	The Id of Ad Account.
Target	String	The target to get ad accounts from such as a business id.
AccountId	String	The Id of the Ad Account when viewed directly in Facebook.
AccountStatus	Integer	Status of the account. 1 = Active, 2 = Disabled, 3 = Unsettled, 7 = Pending Review, 9 = in Grace Period, 101 = temporarily unavailable, 100 = pending closure.
Age	Double	Amount of time the ad account has been open, in days.
AmountSpent	Integer	Current total amount spent by the account. This can be reset.
Balance	Integer	Bill amount due.
BusinessCity	String	City for business address.
BusinessCountryCode	String	Country code for the business address.
BusinessName	String	The business name for the account.
BusinessState	String	State abbreviation for business address.
BusinessStreet	String	First line of the business street address for the account.
BusinessStreet2	String	Second line of the business street address for the account.
BusinessZip	String	Zip code for business address.
Capabilities	String	Capabilities allowed for this ad account.
CreatedTime	Datetime	The time the account was created.
Currency	String	The currency used for the account, based on the corresponding value in the account settings.
MinCampaignGroupSpendCap	String	The minimum campaign group spend limit.
Name	String	Name of the account; note that many accounts are unnamed, so this field may be empty.
OffsitePixelsTosAccepted	String	Indicates whether the offsite pixel Terms Of Service contract was signed.
OwnerId	String	Facebook ID of the owner fo the Ad Account.
SpendCap	Integer	The maximum that can be spent by this account after which campaigns will be paused. A value of 0 signifies no spending-cap.
TimezoneId	String	ID for the timezone.
TimezoneName	String	Name for the time zone.
TimezoneOffsetHoursUTC	Double	Time Zone difference from UTC.

Query information about an Ad Creative or the Ad Creatives on a specific Ad Account, Ad Set, or Ad. Accessing Ad Creative information requires the ads_read permission.

Table Specific Information

AdCreatives in Facebook represent a collection of the creatives for specific Ads in Facebook.

Select

When querying ad creatives, either the Id or Target must be used to filter results. The Target may be an ad account, ad set, or ad. For instance:

SELECT * FROM AdCreatives WHERE Target = 'adid'

Columns

Name	Type	Description
ID [KEY]	String	The Id of Ad Creative.
Target	String	The Ad Account Id or Campaign Id to get Ad Sets of.
Name	String	The name of the Ad Creative.
ApplinkTreatment	String	Deep link fallback behavior for dynamic product ads if the app is not installed. The allowed values are deeplink_with_web_fallback, deeplink_with_appstore_fallback, web_only.
Body	String	The body of the ad.
CallToActionType	String	The call to action button text and header text of legacy ads. The allowed values are OPEN_LINK, LIKE_PAGE, SHOP_NOW, PLAY_GAME, INSTALL_APP, USE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, BOOK_TRAVEL, LISTEN_MUSIC, LEARN_MORE, SIGN_UP, DOWNLOAD, WATCH_MORE, NO_BUTTON, CALL_NOW, BUY_NOW, GET_OFFER, GET_OFFER_VIEW, GET_DIRECTIONS, MESSAGE_PAGE, SUBSCRIBE, SELL_NOW, DONATE_NOW, GET_QUOTE, CONTACT_US, RECORD_NOW, VOTE_NOW, REGISTER_NOW, OPEN_MOVIES.
EffectiveInstagramMediaId	String	The ID of an Instagram post to use in an ad.
ImageHash	String	Image hash for an image you can use in creatives.
ImageUrl	String	A URL for the image for this creative. The image specified at this URL will be saved into the ad account's image library.
InstagramPermalinkUrl	String	Instagram permalink.
InstagramUserId	String	The ID of an Instagram user for creating ads.
LinkOgId	String	The Open Graph (OG) ID for the link in this creative if the landing page has OG tags.
LinkUrl	String	Used to identify a specific landing tab on the Page (e.g. a Page tab app) by the Page tab's URL.
ObjectId	String	The ID of the promoted_object or object that is relevant to the ad and ad type.
ObjectStoryId	String	The ID of a page post to use in an ad.
ObjectType	String	The type of object that is being advertised. The allowed values are APPLICATION, DOMAIN, EVENT, OFFER, PAGE, PHOTO, SHARE, STATUS, STORE_ITEM, VIDEO, INVALID.
ObjectUrl	String	Destination URL for a link ads not connected to a page.
PageId	String	The actor ID (Page ID) of this creative.
ProductSetId	String	The ID of the product set for this creative.
RunStatus	String	The run status of this creative. The allowed values are ACTIVE, DELETED.
SourceInstagramMediaId	String	The ID of an Instagram post for creating ads.
TemplateUrl	String	The Tracking URL for dynamic product ads.
ThumbnailUrl	String	The URL to a thumbnail for this creative.
Title	String	Title for a link ad (not connected to a Page).
UrlTags	String	A set of query string parameters which will replace or be appended to urls clicked from page post ads, message of the post, and canvas app install creatives only.
UsePageActorOverride	Boolean	If this is true, we will show the page actor for mobile app ads.
AdLabels	String	Ad Labels that are associated with this creative.
ObjectStorySpecLinkData	String	The link data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecPhotoData	String	The photo data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecVideoData	String	The video data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTextData	String	The text data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.
ObjectStorySpecTemplateData	String	The template data to create a new unpublished page post. Will only have a value when other ObjectStorySpec columns are null.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name	Type	Description
ThumbnailHeight	String	Rendered height of thumbnails provided in thumbnail_url, in pixels. Default 64.
ThumbnailWidth	String	Rendered width of thumbnails provided in thumbnail_url, in pixels. Default 64.

Images associated with an ad account

Table Specific Information

Ad Images in Facebook represent individual images that can be used with ad creatives.

Select

When querying ad images, a Target can be specified so that ad images are queried for the correct ad account. If no Target is specified, the driver will query from the first ad account it finds for your user account:

SELECT * FROM AdImages WHERE Target = 'act_123456'

Columns

Name	Type	Description
ID	String	The Id of image.
Target	String	The target ad account to pull images from.
AccountId	String	The id of the ad account of the image.
CreatedTime	Datetime	The datetime the image was created.
Creatives	String	The name of the Ad the lead originates from.
hash	String	The unique hash of the image.
height	Integer	The height of the image.
width	Integer	The width of the image.
AssociatedWithCreatives	Boolean	Whether the image is associated with any ad creatives.
name	String	The filename of the image.
OriginalHeight	Integer	The height of the original uploaded image
OriginalWidth	Integer	The width of the original uploaded image
Status	String	The status of the image.
PermalinkUrl	String	The permanent URL of the image to use in ad creatives.

Queries an Ad Report. Accessing Ad Report information requires the ads_read permission.

Table Specific Information

Facebook AdInsights can be requested with a great amount of detail, to simulate the same sort of information that can be retrieved in a report.

Select

When requesting AdInsights, always include a Target. The Target specifies the element from which to retrieve the insights. Legal Targets are AdAccount, Campaign, AdSet, or an Ad. For example:

SELECT * FROM AdInsights WHERE Target = 'act_123456'

Columns that are always fetched by default during a SELECT * query against Adinsights:

• Target
• DateStart
• DateEnd
• AccountCurrency
• AdAccountId
• AdAccountName
• Impressions
• Spend

Metrics Columns

When running a SELECT * query on an Adinsights report, not all of the metrics columns are retrieved from Facebook. This means that certain columns may return “0” or null values if column metadata is retrieved in a prior request. To fetch this data, these columns must be included in the SELECT portion of the query, rather than using SELECT *.

Metrics columns that may display this behavior in Adinsights include:

• BuyingType
• Clicks
• ConversionRateRanking
• CostPerEstimatedAdRecallers
• CostPerInlineLinkClick
• CostPerInlinePostEngagement
• CostPerUniqueClick
• CostPerUniqueInlineLinkClick
• CPC
• CPM
• CPP
• CTR
• EstimatedAdRecallRate
• EstimatedAdRecallers
• Frequency
• Impressions
• InlineLinkClicks
• InlineLinkClicksCounter
• InlinePostEngagement
• InstantExperienceClicksToOpen
• InstantExperienceClicksToStart
• InstantExperienceOutboundClicks
• Objective
• QualityRanking
• Reach
• Spend
• UniqueClicks
• UniqueCTR
• UniqueInLineLinkClicks
• UniqueInLineLinkClickCounter
• UniqueLinkClicksCounter
• Checkins
• EventResponses
• LinkClicks
• OfferSaves
• OutboundClicks
• PageEngagements
• PageLikes
• PageMentions
• PagePhotoViews
• PostComments
• PostEngagements
• PostShares
• PostReactions
• PageTabViews
• Video3SecondViews

Date Presets

To specify a data range, use either DateStart and DateEnd, or DatePreset. Available values for DatePreset:

• maximum
• today
• yesterday
• this_week_sun_today
• this_week_mon_today
• last_week_sun_sat
• last_week_mon_sun
• last_3d
• last_7d
• last_14d
• last_28d
• last_30d
• last_90d
• this_month
• last_month

For example:

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DateStart >= '01/01/2015' AND DateEnd <= '03/31/2015'

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d'

To specify how many days should be included in each report row, use TimeIncrement. For example:

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d' AND TimeIncrement = '7'

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND DatePreset = 'last_90d' AND TimeIncrement = 'monthly'

To specify the level at which insights should be retrieved, use the Level column. Legal values are ad, adset, campaign, or account. For example:

SELECT DateStart, DateEnd, AdAccountId, Age, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' AND Level = 'campaign'

Note: Both the DatePreset and the breakdowns are subject to frequent changes by Facebook. The lists above may be outdated due to Facebook changes. To see the most currently available breakdowns and date presets, see the documentation on Facebook for parameters and breakdowns at https://developers.facebook.com/docs/marketing-api/insights/.

Breakdown Columns

There are a number of breakdown columns. In general, only one breakdown column can be selected at a time. If you use SELECT *, no breakdown columns will be used. The available breakdown columns are:

• Age: Can also be selected with Gender
• Country
• FrequencyValue
• Gender: Can also be selected with Age
• HStatsByAdvertiserTZ (Hourly Stats by Advertizer Timezone)
• HStatsByAudienceTZ (Hourly Stats by Audience Timezone)
• ImpressionDevice: Can also be selected with PublisherPlatform or both PublisherPlatform and PlatformPosition.
• PlatformPosition: Must be selected with PublisherPlatform. Can also be selected with ImpressionDevice.
• PublisherPlatform: Can be selected with PlatformPosition, ImpressionDevice, or both PlatformPosition and ImpressionDevice.
• ProductId
• Region

Most other columns not already mentioned can be used with standard SQL WHERE clause modifiers. For instance:

SELECT DateStart, DateEnd, AdAccountId, Spend, Impressions FROM AdInsights WHERE Target = 'act_123456' WHERE Impressions > 10000 AND Spend < 1000

Facebook Ads enforces restrictions on what breakdowns can be selected together, so by default the Cloud also enforces similar restrictions on breakdowns in queries supplied to it. If desired, you can bypass internal enforcement of breakdown restrictions by setting IgnoreValidationException to True. This passes any supplied breakdown combination to Facebook as-is.

Note: Both the DatePreset and the breakdowns are subject to frequent changes by Facebook. The lists above may be outdated due to Facebook changes. To see the most currently available breakdowns and date presets, see the documentation on Facebook for parameters and breakdowns at https://developers.facebook.com/docs/marketing-api/insights/.

Managing Query Size

Sometimes if a query is too large for Facebook to process on its end, you might receive this error: Please reduce the amount of data you're asking for, then retry your request. The error appears to be triggered by individually dense fields, and not the page size.

If the Cloud encounters this error when first executing certain types of queries, the driver attempts to retry the query at the next lowest level of ad object, down to the level defined in RetryLevel, as long as the query does not include the Level parameter. (If the Level parameter is specified in a query, the driver does not attempt to retry beyond the ad object level specified by Level. For further information, see RetryLevel.) Note that since spreading queries across more granular ad objects increases the number of requests executed for the query, it can decrease query performance.

If you continue to receive this error, try either reducing the date range of the query, or removing expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. If you get the same error, reduce the remaining columns by half and try again. If you do not get an error, add back half of the columns you just removed, and try again.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range is automatically calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
AccountCurrency	String	The currency that is being used by the ad account.
ActionAttributionWindows	String	A comma separated list that determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId	String	The Id of the Ad Account that is associated with the report row.
AdAccountName	String	The name of the Ad Account that is associated with the report row.
CampaignId	String	The Id of the Campaign that is associated with the report row.
CampaignName	String	The name of the Campaign that is associated with the report row.
AdSetId	String	The Id of the Ad Set that is associated with the report row.
AdSetName	String	The name of the Ad Set that is associated with the report row.
AdId	String	The Id of the Ad that is associated with the report row.
AdName	String	The name of the Ad that is associated with the report row.
BuyingType	String	The method by which target ads are paid for in your campaigns.
Clicks	Long	The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field.
ConversionRateRanking	String	The conversion rate ranking.
CostPerEstimatedAdRecallers	Decimal	The average cost per additional person that we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick	Decimal	The average cost per click on links in the ad.
CostPerInlinePostEngagement	Decimal	The average cost per engagement on the post.
CostPerUniqueClick	Decimal	The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick	Decimal	The average you paid for each unique inline link click.
CPC	Decimal	The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM	Decimal	The average cost that you've paid to have 1,000 impressions on your ad.
CPP	Decimal	The average cost that you've paid to have your ad served to 1,000 unique people.
CTR	Double	The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
EstimatedAdRecallRate	Double	The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers	Double	The additional number of people that we estimate will remember seeing your ads if asked within 2 days.
Frequency	Double	The average number of times that your ad was served to each person.
Impressions	Long	The number of times that your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks	Long	Total number of clicks on links in the ad.
InlineLinkClicksCounter	Double	The click-through rate for inline clicks to link.
InlinePostEngagement	Long	The total number of engagements on the post.
InstantExperienceClicksToOpen	Long	instant_experience_clicks_to_open
InstantExperienceClicksToStart	Long	instant_experience_clicks_to_start
InstantExperienceOutboundClicks	Long	instant_experience_outbound_clicks
Objective	String	The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
QualityRanking	String	The quality ranking.
Reach	Long	The number of people your ad was served to.
Spend	Decimal	The total amount you've spent so far.
UniqueClicks	Long	The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it counts as 3 unique clicks.
UniqueCTR	Double	The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks	Long	The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter	Double	The click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter	Double	The unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
TotalPostbacks	String	Total postbacks. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
TotalPostbacksDetailed	String	Total postbacks detailed. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
Checkins	Int	The number of checkins attributed to the Ad.
EventResponses	Int	The number of event responses attributed to the Ad.
LinkClicks	Int	The number of link clicks attributed to the Ad.
OfferSaves	Int	The number of receive offers attributed to the Ad.
OutboundClicks	Int	The number of outbound clicks attributed to the Ad.
PageEngagements	Int	The number of page enagements attributed to the Ad.
PageLikes	Int	The number of page likes attributed to the Ad.
PageMentions	Int	The number of page mentions attributed to the Ad.
PagePhotoViews	Int	The number of photo views attributed to the Ad.
PostComments	Int	The number of post comments attributed to the Ad.
PostEngagements	Int	The number of post engagements attributed to the Ad.
PostShares	Int	The number of post shares attributed to the Ad.
PostReactions	Int	The number of post reactions attributed to the Ad.
PageTabViews	Int	The number of tab views attributed to the Ad.
Video3SecondViews	Int	The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played.
PixelAddToCart	Int	Pixel adds to cart.
PixelPurchase	Int	Pixel purchases.
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Country	String	The country for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
DMA	String	The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
FrequencyValue	String	The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
HStatsByAdvertiserTZ	String	Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
HStatsByAudienceTZ	String	Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImpressionDevice	String	The devices used to view the Ad. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
PlacePageId	String	The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns.
PlatformPosition	String	The position on the platform.
ProductId	String	The product Id advertised in the Ad. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
PublisherPlatform	String	The platforms the ads were published on.
Region	String	The region someone viewed the Ad from. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdFormatAsset	String	Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetId	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetText	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetId	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetName	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetId	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetText	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetId	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetHash	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetUrl	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetId	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetText	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetId	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetWebsiteUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetDisplayUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetThumbnailUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoName	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AppId	String	The ID of the application associated with the ad account or campaign requested. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
IsConversionIdModeled	String	Whether the conversion_bits are modeled. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanCampaignId	String	The raw campaign ID received as a part of Skan postback from iOS 15+. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanConversionId	String	The assigned Conversion ID of the event and or event bundle configured in the application's SKAdNetwork configuration schema. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
UserSegmentKey	String	User segment of Advantage+ Shopping Campaigns. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdEffectiveStatus	String	An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.
DefaultSummary	Boolean	A boolean indicating if we should get the default summary.

Query an Ad Report. Accessing Ad Report information requires the ads_read permission.

Table Specific Information

AdInsightsActions represents a breakdown of the Actions column from the AdInsights. See AdInsights for general information on querying AdInsights.

Select

When requesting AdInsightsActions, always include a Target. The Target specifies the element from which to retrieve the insights. Legal Targets are AdAccount, Campaign, AdSet, or an Ad. For example:

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456'

Columns that are always fetched by default during a SELECT * query against Adinsightsactions:

• Target
• DateStart
• DateEnd
• AdAccountId
• AdAccountName

Metrics Columns

When running a SELECT * query on an Adinsightsactions report, not all of the metrics columns are retrieved from Facebook. This means that certain columns may return “0” or null values if column metadata is retrieved in a prior request.

Metrics columns that may display this behavior in Adinsightsactions include:

• ActionType
• ActionValue
• Action1dClick
• Action1dView
• Action7dClick
• Action7dView
• Action28dClick
• Action28dView
• ActionDDA

ActionAttributionWindows

To input a comma-separated list of attribution windows, use ActionAttributionWindows. For example:

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND level = 'ad' AND ActionAttributionWindows = '1d_view,7d_view,28d_click'

ActionCollection

To identify a specific collection to retrieve from AdInsightsActions, use ActionCollection. If no collection is specified, the driver uses Actions by default. Each input represents an available column from AdInsights where a collection of actions would return.

To identify multiple collections, use ActionCollection with the IN clause.

For example:

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection = 'UniqueActions'

SELECT * FROM AdInsightsActions WHERE Target = 'act_123456' AND ActionCollection IN ('Actions', 'UniqueActions')

Breakdown Columns

Just as in the available selection criterias from AdInsights, breakdowns are available for the Adinsightsactions report. For further information about breakdowns, see AdInsights.

Additional breakdowns available for AdInsightsActions include:

• ActionType
• ActionCanvasComponentName
• ActionCarouselCardId
• ActionCarouselCardName
• ActionDestination
• ActionDevice
• ActionLinkClickDestination
• ActionReaction
• ActionTargetId
• ActionVideoSound
• ActionVideoType

Managing Query Size

Sometimes if a query is too large for Facebook to process on its end, you might receive this error: Please reduce the amount of data you're asking for, then retry your request. The error appears to be triggered by individually dense fields, and not the page size.

If the Cloud encounters this error when first executing certain types of queries, the driver attempts to retry the query at the next lowest level of ad object, down to the level defined in RetryLevel, as long as the query does not include the Level parameter. (If the Level parameter is specified in a query, the driver does not attempt to retry beyond the ad object level specified by Level. For further information, see RetryLevel.) Note that since spreading queries across more granular ad objects increases the number of requests executed for the query, it can decrease query performance.

If you continue to receive this error, try either reducing the date range of the query, or removing expensive columns.

A good method for finding and removing expensive columns is to use a binary search by removing half of the columns you are selecting and retrying the query. If you get the same error, reduce the remaining columns by half and try again. If you do not get an error, add back half of the columns you just removed, and try again.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionAttributionWindows	String	A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
ActionCollection	String	The action collection to retrieve. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas The default value is Actions.
AdAccountId	String	The Id of the Ad Account associated with the report row.
AdAccountName	String	The name of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
AdId	String	The Id of the Ad associated with the report row.
AdName	String	The name of the Ad associated with the report row.
TotalPostbacks	String	Total postbacks. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
TotalPostbacksDetailed	String	Total postbacks detailed. Due to API limitations, this field cannot be selected with any additional fields, and therefore is not included when the query projection contains a wildcard.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Double	Metric value of default attribution window.
Action1dClick	String	Metric value of attribution window 1 day after clicking the ad.
Action1dView	String	Metric value of attribution window 1 day after viewing the ad.
Action7dClick	String	Metric value of attribution window 7 days after clicking the ad.
Action7dView	String	Metric value of attribution window 7 days after viewing the ad.
Action28dClick	String	Metric value of attribution window 28 days after clicking the ad.
Action28dView	String	Metric value of attribution window 28 days after viewing the ad.
ActionDDA	String	Metric value of attribution window which is powered by data driven model.
ActionCanvasComponentName	String	Name of a component within a Canvas ad.
ActionCarouselCardId	String	The ID of the specific carousel card that people engaged with when they saw your ad.
ActionCarouselCardName	String	The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.
ActionDestination	String	The destination where people go after clicking on your ad.
ActionDevice	String	The device on which the conversion event you are tracking occurred.
ActionReaction	String	The number of reactions on your ads or boosted posts.
ActionTargetId	String	The id of destination where people go after clicking on your ad.
ActionVideoSound	String	The sound status (on/off) when user watches your video ad.
ActionVideoType	String	Video metrics breakdown.
ConversionDestination	String	Conversion destination.
SignalSourceBucket	String	Signal source bucket.
StandardEventContentType	String	Standard canvas component name.
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Country	String	The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
DMA	String	The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
FrequencyValue	String	The number of times an ad in your Reach and Frequency campaign was served to each person. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
HStatsByAdvertiserTZ	String	Time period over which the stats were taken for the advertiser. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
HStatsByAudienceTZ	String	Time period over which the stats were taken for the audience. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
ImpressionDevice	String	The devices used to view the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
PlacePageId	String	The place page used if applicable. This is a breakdown column that may not be selected with other breakdown columns.
PlatformPosition	String	The position on the platform.
ProductId	String	The product Id advertised in the Ad. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
PublisherPlatform	String	The platforms the ads were published on.
Region	String	The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
AdFormatAsset	String	Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetId	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetText	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetId	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetName	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetId	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetText	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetId	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetHash	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetUrl	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetId	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetText	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetId	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetWebsiteUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetDisplayUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetThumbnailUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoName	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AppId	String	The ID of the application associated with the ad account or campaign requested. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
IsConversionIdModeled	String	Whether the conversion_bits are modeled. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanCampaignId	String	The raw campaign ID received as a part of Skan postback from iOS 15+. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacksDetailed field.
SkanConversionId	String	The assigned Conversion ID of the event and or event bundle configured in the application's SKAdNetwork configuration schema. This is a breakdown column and selecting this column causes results to be further broken down by this metric. Only supported by the TotalPostbacks field.
UserSegmentKey	String	User segment of Advantage+ Shopping Campaigns. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdEffectiveStatus	String	An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Queries an Ad Report with asset breakdowns. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Ad or Ad Set for which to get insights. Note that the asset breakdowns cannot target an Ad Account.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range is automatically calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
AccountCurrency	String	The currency that is being used by the ad account.
ActionAttributionWindows	String	A comma separated list that determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default option means [1d_view,28d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default.
AdAccountId	String	The Id of the Ad Account that is associated with the report row.
AdAccountName	String	The name of the Ad Account that is associated with the report row.
CampaignId	String	The Id of the Campaign that is associated with the report row.
CampaignName	String	The name of the Campaign that is associated with the report row.
AdSetId	String	The Id of the Ad Set that is associated with the report row.
AdSetName	String	The name of the Ad Set that is associated with the report row.
AdId	String	The Id of the Ad that is associated with the report row.
AdName	String	The name of the Ad that is associated with the report row.
BuyingType	String	The method by which target ads are paid for in your campaigns.
Clicks	Long	The total number of clicks on your ad. Depending on what you're promoting, this can include Page likes, event responses or app installs. In the Facebook UI, this is the Clicks (All) field.
ConversionRateRanking	String	The conversion rate ranking.
CostPerEstimatedAdRecallers	Decimal	The average cost per additional person that we estimate will recall seeing your ad if asked within 2 days.
CostPerInlineLinkClick	Decimal	The average cost per click on links in the ad.
CostPerInlinePostEngagement	Decimal	The average cost per engagement on the post.
CostPerUniqueClick	Decimal	The average cost per unique click for these ads, calculated as the amount spent divided by the number of unique clicks received.
CostPerUniqueInlineLinkClick	Decimal	The average you paid for each unique inline link click.
CPC	Decimal	The average cost per click for these ads, calculated as the amount spent divided by the number of clicks received.
CPM	Decimal	The average cost that you've paid to have 1,000 impressions on your ad.
CPP	Decimal	The average cost that you've paid to have your ad served to 1,000 unique people.
CTR	Double	The number of clicks you received divided by the number of impressions. In the Facebook UI, this is the CTR (All) % field.
EstimatedAdRecallRate	Double	The estimated number of people who recall your ad divided by the number of people your ad reached.
EstimatedAdRecallers	Double	The additional number of people that we estimate will remember seeing your ads if asked within 2 days.
Frequency	Double	The average number of times that your ad was served to each person.
Impressions	Long	The number of times that your ad was served. On our mobile apps an ad is counted as served the first time it's viewed. On all other Facebook interfaces, an ad is served the first time it's placed in a person's News Feed or each time it's placed in the right column.
InlineLinkClicks	Long	Total number of clicks on links in the ad.
InlineLinkClicksCounter	Double	The click-through rate for inline clicks to link.
InlinePostEngagement	Long	The total number of engagements on the post.
InstantExperienceClicksToOpen	Long	instant_experience_clicks_to_open
InstantExperienceClicksToStart	Long	instant_experience_clicks_to_start
InstantExperienceOutboundClicks	Long	instant_experience_outbound_clicks
Objective	String	The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising.
QualityRanking	String	The quality ranking.
Reach	Long	The number of people your ad was served to.
Spend	Decimal	The total amount you've spent so far.
UniqueClicks	Long	The total number of unique people who have clicked on your ad. For example, if 3 people click on the same ad 5 times, it counts as 3 unique clicks.
UniqueCTR	Double	The number of people who clicked on your ad divided by the number of people you reached. For example, if you received 20 unique clicks and your ad was served to 1,000 unique people, your unique click-through rate would be 2%.
UniqueInlineLinkClicks	Long	The number of unique inline link clicks that your ad got. In the Facebook UI, this is the Unique Clicks to Link field.
UniqueInlineLinkClickCounter	Double	The click-through rate for unique inline clicks to link.
UniqueLinkClicksCounter	Double	The unique click-through rate for clicks to link. The number of people who clicked on the link in your ad that directs people off Facebook divided by the number of people you reached. Example: if you received 20 unique clicks to link and your ad was shown to 1,000 unique people, your unique click-through rate would be 2%.
Checkins	Int	The number of checkins attributed to the Ad.
EventResponses	Int	The number of event responses attributed to the Ad.
LinkClicks	Int	The number of link clicks attributed to the Ad.
OfferSaves	Int	The number of receive offers attributed to the Ad.
OutboundClicks	Int	The number of outbound clicks attributed to the Ad.
PageEngagements	Int	The number of page enagements attributed to the Ad.
PageLikes	Int	The number of page likes attributed to the Ad.
PageMentions	Int	The number of page mentions attributed to the Ad.
PagePhotoViews	Int	The number of photo views attributed to the Ad.
PostComments	Int	The number of post comments attributed to the Ad.
PostEngagements	Int	The number of post engagements attributed to the Ad.
PostShares	Int	The number of post shares attributed to the Ad.
PostReactions	Int	The number of post reactions attributed to the Ad.
PageTabViews	Int	The number of tab views attributed to the Ad.
Video3SecondViews	Int	The number of video views attributed to the Ad. Views count if at least 3 seconds or the entire video (if the video is less than 3 seconds) were played.
PixelAddToCart	Int	Pixel adds to cart.
PixelPurchase	Int	Pixel purchases.
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetId	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
BodyAssetText	String	Body asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetId	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
DescriptionAssetText	String	Description asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetId	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetHash	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
ImageAssetUrl	String	Image asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetId	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
TitleAssetText	String	Title asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetId	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
CallToActionAssetName	String	Call to action asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetId	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetWebsiteUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
LinkUrlAssetDisplayUrl	String	Link url asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoId	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetThumbnailUrl	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
VideoAssetVideoName	String	Video asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdFormatAsset	String	Ad format asset level breakdown. This is a breakdown column and selecting this column causes results to be further broken down by this metric.
AdEffectiveStatus	String	An input only list of supported statuses when retrieving insights at a level lower than the Ad Account. See the values listed on AdStatus for an example of valid values.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.
DefaultSummary	Boolean	A boolean indicating if we should get the default summary.

Query information about ad labels. Accessing Ad Information requires the ads_read permission.

Columns

Name	Type	Description
ID [KEY]	String	The Id of Ad label.
Target	String	The Ad Account Id to retrieve labels from.
Name	String	The name of the Ad label.
CreatedTime	Datetime	The time when the Ad label was created.
UpdatedTime	Datetime	When the Ad label was last updated.

Query information about an Ad or the Ads in a specific Ad Set, Campaign, or Ad Account. Accessing Ad Information requires the ads_read permission.

Table Specific Information

Ads in Facebook represent individual ads that have been created.

Select

When querying ad accounts, either the Id or Target must be used to filter results. For instance:

SELECT * FROM Ads WHERE Target = 'act_123456'

Additionally, UpdatedTime may be used with the > or >= operators to retrieve only records newer than a certain date. For instance:

SELECT * FROM Ads WHERE Target = 'act_123456' AND UpdatedTime > '01/01/2016' 

Columns

Name	Type	Description
ID [KEY]	String	The Id of Ad.
Target	String	The Ad Account Id, Campaign Id, or Ad Set Id to get Ads in.
Name	String	The name of the Ad.
AdStatus	String	The status of the Ad. The allowed values are ACTIVE, PAUSED, CAMPAIGN_PAUSED, CAMPAIGN_GROUP_PAUSED, CREDIT_CARD_NEEDED, DISABLED, DISAPPROVED, PENDING_REVIEW, PREAPPROVED, PENDING_BILLING_INFO, ARCHIVED, DELETED.
BidInfo	String	The value of the bid info taken from the Ad Set.
BidType	String	The bid type value taken from the Ad Set. The allowed values are CPM, CPC, MULTI_PREMIUM, ABSOLUTE_OCPM, CPA.
CampaignId	String	The Id of the Campaign the Ad belongs to.
AdSetId	String	The Id of the Ad Set the Ad belongs to.
AdCreativeId	String	The Id of the Ad Creative associated with the Ad.
ConfiguredStatus	String	The configured status of the ad. Prefer using 'status' instead of this. The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED.
CreatedTime	Datetime	The time when the Ad was created.
UpdatedTime	Datetime	When the Ad was last updated.
ConversionSpecs	String	The Ad's conversion specs.
FailedDeliveryChecks	String	Possible checks that could have failed which will prevent the Ad from showing up.
Recommendations	String	If there are recommendations for this ad, this field includes them. Otherwise, this field will be null.
TrackingSpecs	String	The Ad's tracking specification. This field will be defaulted based on the objective, if not set to NONE, or based on the ad creative.
AdActiveTime	String	The time from when the ad was recently active.
AdScheduleEndTime	Datetime	An optional parameter that defines the end time of an individual ad. If no end time is defined, the ad will run on the campaign’s schedule.
AdScheduleStartTime	Datetime	An optional parameter that defines the start time of an individual ad. If no start time is defined, the ad will run on the campaign’s schedule.
BidAmount	Integer	Bid amount for this ad which will be used in auction.
LastUpdatedByAppId	String	Indicates the app used for the most recent update of the ad.
PreviewShareableLink	String	A link that enables users to preview ads in different placements.
SourceAdId	String	The source ad id that this ad is copied from.

Query information about an Ad Set or the Ad Sets on a specific Campaign or Ad Account. Accessing Ad Set information requires the ads_read permission.

Table Specific Information

AdSets in Facebook represent a collection of Ads in Facebook.

Select

When querying ad sets, either the Id or Target must be used to filter results. The Target may be an ad account, or a campaign. For instance:

SELECT * FROM AdSets WHERE Target = 'act_123456'

Columns

Name	Type	Description
ID [KEY]	String	The Id of Ad Set.
Target	String	The Ad Account Id or Campaign Id to get Ad Sets of.
Name	String	The name of the Ad Set.
BudgetRemaining	Integer	The amount of budget remaining for this Ad Set.
CampaignId	String	The Ad Campaign this ad set is a part of.
AdSetStatus	String	The status of the Ad Set. The allowed values are ACTIVE, PAUSED, ARCHIVED, DELETED.
BillingEvent	String	The billing event that this adset is using: APP_INSTALLS: Pay when people install your app. CLICKS: Pay when people click anywhere in the ad. IMPRESSIONS: Pay when the ads are shown to people. LINK_CLICKS: Pay when people click on the link of the ad. OFFER_CLAIMS: Pay when people claim the offer. PAGE_LIKES: Pay when people like your page. POST_ENGAGEMENT: Pay when people engage with your post. VIDEO_VIEWS: Pay when people watch videos.
CreatedTime	Datetime	When the Ad Set was created.
DailyBudget	Integer	The daily budget of the set defined in your account currency, it is allowed only for ad sets with a duration longer than 24 hours.
LifetimeBudget	Decimal	The lifetime budget of the set defined in your account currency.
EndTime	Datetime	When the Ad Set is scheduled to end.
StartTime	Datetime	When the Ad Set started.
UpdatedTime	Datetime	The time the Ad Set was last updated.
Recommendations	String	If there are recommendations for this ad set, this field includes them. Otherwise, this field will be null.
TargetingGenders	Integer	Indicates gender-based targeting. 0=all, 1=male, 2=female. The allowed values are 0, 1, 2.
TargetingAgeMax	Integer	Maximum age. If used, must be 65 or lower.
TargetingAgeMin	Integer	Minimum age. If used, must be 13 or higher. If omitted, will default to 18.
TargetingCountries	String	Values for country targeting.
TargetingLocationTypes	String	Values for the types of locations to target.
TargetingRegions	String	The state, province, or region.
TargetingCities	String	Cities to target with a radius and distance.
TargetingZips	String	The zip codes used for targeting.
TargetingCustomLocations	String	Any custom locations to target.
TargetingGeoMarkets	String	They key for the market. The destination market areas (DMA) and keys are in the format DMA:NUMBER, such as DMA:501.
TargetingInterests	String	Interests to target based on.
TargetingBehaviors	String	Behaviors to target based on.
TargetingDevicePlatforms	String	The device platforms to target.
TargetingPublisherPlatforms	String	The publisher platforms to target.
TargetingInstagramPositions	String	The instagram positions to target.
TargetingPageTypes	String	The types of pages to use when targeting. Values may include desktop, feed, desktopfeed, mobile, rightcolumn, rightcolumn-and-mobile, home, mobilefeed-and-external, desktop-and-mobile-and-external, feed-and-external, rightcolumn-and-mobile-and-external.
LearningStageInfoStatus	String	Learning Phase progress for the ad set.

Query Albums associated with a Target. Accessing Album information typically requires the user_photos permission.

Columns

Name	Type	Description
ID [KEY]	String	The Id of the album.
Target	String	The Id or username of the target you are retrieving albums from.
Name	String	The name of the album.
FromId	String	Id of the user who owns the album.
FromName	String	Name of the user who owns the album.
FromPicture	String	The picture of user the album is from.
FromCategory	String	The category of user the album is from. FromCategory may only be retrieved if the other From* fields are not selected.
Description	String	A description of the album.
Location	String	The location of the album.
Link	String	A link to this album on Facebook.
CoverPhoto	String	The album cover photo Id.
Privacy	String	The privacy settings for the album.
Count	Integer	The number of photos in this album.
Type	String	The type of the album: profile, mobile, wall, normal or album.
CommentsCount	Integer	The number of comments for the album.
CommentsData	String	An aggregate of comment data.
CreatedTime	Datetime	When the album was uploaded.
UpdatedTime	Datetime	When the album was last updated.

Ad Accounts authorized to run ads for your business on a specified app. This view requires that you have at least one business configured for your user id.

Table Specific Information

AuthorizedAdAccounts in Facebook represent the ad accounts that have been authorized for advertising on the specified application for your Facebook business. You must have a business set up in Facebook for this view to work correctly.

Select

When querying AuthorizedAdAccounts, a Target must be specified and a business may optionally be specified. For instance:

SELECT * FROM AdAccounts WHERE Target = 'ApplicationId' AND Business = 'BusinessId'

If no business is specified, results for all of your available businesses will come back.

Columns

Name	Type	Description
ID [KEY]	String	The Id of the Ad Account.
Target	String	The app id to request authorized ad accounts from.
AccountId	String	The Id of the Ad Account when viewed directly in Facebook.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name	Type	Description
Business	String	The id of the business to retrieve authorized ad accounts for.

Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
AdId	String	The Id of the Ad associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on ads, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
AdSetId	String	The Id of the Ad Set associated with the report row.
AdSetName	String	The name of the Ad Set associated with the report row.
AdId	String	The Id of the Ad associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on ads and providing information on parent campaigns and ad sets, broken down by action type. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Query the Businesses of a Facebook user. Accessing Business information requires the business_management permission.

Columns

Name	Type	Description
ID [KEY]	String	The Id of the business.
Name	String	The name of the business.
PrimaryPage	String	The primary page of the business.
TimezoneId	String	The timezone id of the business.
Link	String	The link of the business.
CreatedTime	Datetime	When the business was added.
UpdatedTime	Datetime	When the business was updated.

Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.

Table Specific Information

Campaigns in Facebook represent advertising campaigns that individual Ads or AdSets may be a part of.

Select

When querying campaigns, either the Id or Target must be used to filter results. The Target must be an ad account. For instance:

SELECT * FROM Campaigns WHERE Target = 'act_123456'

Columns

Name	Type	Description
ID [KEY]	String	The Id of Campaign.
Target	String	The target or Ad Account Id to get Campaigns.
Name	String	The name of the Campaign.
BuyingType	String	This field will help Facebook make future optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type. The allowed values are AUCTION, FIXED_CPM, RESERVED.
ConfiguredStatus	String	If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this. The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED.
EffectiveStatus	String	The effective status of this campaign. For example, when all Ad Sets beneath the campaign are paused, the effective status is ADSET_PAUSED.. The allowed values are ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED.
Status	String	If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use. The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED.
CreatedTime	Datetime	When the campaign was created.
Objective	String	Objective of this ad campaign. If it is specified the API will validate that any ad groups created under the campaign match that objective. The allowed values are CANVAS_APP_ENGAGEMENT, CANVAS_APP_INSTALLS, EVENT_RESPONSES, MOBILE_APP_ENGAGEMENT, MOBILE_APP_INSTALLS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, WEBSITE_CLICKS, WEBSITE_CONVERSIONS.
SpendCap	Int	A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.
DailyBudget	Int	The daily budget of the campaign.
BudgetRemaining	Int	The remaining budget of the campaign.
LifetimeBudget	Int	The lifetime budget of the campaign.
BidStrategy	String	The bid strategy of the campaign. May be one of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP.
StartTime	Datetime	When the Campaign was started.
StopTime	Datetime	When the Campaign was stopped.
UpdatedTime	Datetime	When the Campaign was last updated.

Ad Report focused on campaigns, broken down by device or platform used for viewing ad. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
PublisherPlatform	String	The platforms the ads were published on.
DevicePlatform	String	The device or platform used for viewing the ad. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
PublisherPlatform	String	The platforms the ads were published on.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by the Meta platform on which it was delivered. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: ActionValues, MobileAppPurchaseRoas, OutboundClicks, WebsitePurchaseRoas
PublisherPlatform	String	The platforms the ads were published on.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by age and gender demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by age demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
Age	String	The age range for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by country demographics. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
Country	String	The country for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by Designated Market Area. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
DMA	String	The designated marketing area. This is a breakdown column that may not be selected with other breakdown columns.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by gender. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
Gender	String	The gender for the metrics in this row. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Ad Report focused on campaigns, broken down by sub-country geographic region. Accessing Ad Report information requires the ads_read permission.

Columns

Name	Type	Description
Target	String	The Id of the Account, Campaign, Ad Group, or Ad to get insights for.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month.
DateStart	Date	The starting date to retrieve insights for. In the Facebook UI, this is the Report Start field. In the Facebook UI, this is the Report Start field.
DateEnd	Date	The ending date to retrieve insights for. In the Facebook UI, this is the Report End field. In the Facebook UI, this is the Report End field.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 1.
Level	String	The level to represent the results at. The allowed values are ad, adset, campaign, account.
ActionType	String	The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it.
ActionValue	Integer	Metric value of default attribution window.
AdAccountId	String	The Id of the Ad Account associated with the report row.
CampaignId	String	The Id of the Campaign associated with the report row.
CampaignName	String	The name of the Campaign associated with the report row.
Reach	Integer	The number of people who saw your ads at least once.
Impressions	Integer	The number of times your ads were on screen.
Frequency	Double	The average number of times each person saw your ad. This value is estimated.
Spend	Double	The estimated total amount of money you've spent on your campaign, ad set or ad during its schedule. What sort of ad object is targeted depends on the Target used for the report.
Cpm	Double	The average cost for 1,000 impressions.
Cpc	Double	The average cost for each click (all).
Ctr	Double	The percentage of times people saw your ad and performed a click (all).
InlineLinkClicks	Integer	The number of clicks on links to select destinations or experiences, on or off Facebook-owned properties.
InlineLinkClickCtr	Integer	The percentage of time people saw your ads and performed an inline link click.
CostPerInlineLinkClick	Double	The average cost of each inline link click.
ActionCollection	String	The action collection to retrieve. The available values are: Actions, CostPerActionType
Region	String	The region someone viewed the Ad from. This is a breakdown column and selecting this column will cause results to be further broken down by this metric.
UseAsync	Boolean	A boolean indicating if an asynchronous call should be used for retrieving the insights.

Query information about a lead. Accessing Lead Information requires the ads_read permission.

Table Specific Information

LeadValues in Facebook represent individual values available from a Lead Ad. The types of values describing a leads are varied and can range from custom information such as a car model, or something general such as name and email.

Select

When querying lead values, either the Id or Target must be used to filter results. The id represents the id of the individual lead while the target must be a Lead Ad. For instance:

SELECT * FROM LeadValues WHERE Target = 'lead_ad_id'

SELECT * FROM LeadValues WHERE Id = 'lead_id'

SELECT * FROM LeadValues WHERE Target IN (SELECT id FROM Ads WHERE Target = 'campaign_id')

Note that many values may come back for a single lead id. The leads themselves are a collection on the Lead Ad, and the lead values are a collection on each individual lead.

Columns

Name	Type	Description
ID	String	The Id of Lead.
Target	String	The target or Ads Id to get Lead values from.
AdId	String	The id of the Ad the lead originates from.
AdName	String	The name of the Ad the lead originates from.
AdSetId	String	The id of the Ad Set the lead is associated with.
AdSetName	String	The name of the Ad Set the lead is associated with.
CampaignId	String	The id of the Campaign the lead is associated with.
CampaignName	String	The name of the Campaign the lead is associated with.
FormId	String	The id of the form the lead originates from.
FieldName	String	The name of the field of lead data.
FieldValues	String	The values for the given field of lead data.
IsOrganic	Boolean	A boolean indicating if the lead is organic.
CreatedTime	Datetime	The datetime the lead was created.

Query the Pages based on the supplied Id.

Table Specific Information

Pages in Facebook are pages that are created by a user and may be maintained by one or multiple users. Pages, like users, may be referred to by Id or by screen name.

Select

When querying pages, if nothing is specified then the pages you administrate will be displayed by default. Otherwise, the Id of the page can be specified. For example:

SELECT * FROM Pages WHERE Id = 'facebook'

Columns

Name	Type	Description
ID [KEY]	String	The Id of the page.
Username	String	The username for the page, if any.
Name	String	The name of the page.
Category	String	The category of the page.
Categories	String	An aggregate of categories associated with the page if multiple categories are available.
Link	String	A link to the page.
Picture	String	A link to the profile picture of the page for the page.
CoverId	String	Id of the cover image for the page.
CoverSource	String	The URL to the cover image for the page.
CoverOffsetY	String	The y-axis offset of the cover image for the page.
CoverOffsetX	String	The x-axis offset of the cover image for the page.
About	String	Basic information about the page.
Description	String	A description of the page, if available.
GeneralInfo	String	General information provided by the page.
LocationStreet	String	The street address of the page.
LocationCity	String	The city for the page.
LocationState	String	The state for the page.
LocationCountry	String	The country for the page.
LocationZip	String	The ZIP code of the page.
LocationLatitude	String	The latitude of the page.
LocationLongitude	String	The longitude of the page.
StoreNumber	Integer	Unique store number for this location page, if applicable.
Phone	String	The phone number of the page, if available.
Website	String	A link to the website for the page.
Likes	Integer	The number of people who like the page.
Checkins	Integer	The total number of users who have checked in to the place associated with the page.
TalkingAboutCount	Integer	The number of users talking about the page.
WereHereCount	Integer	The number of users who were at the location the page is for, if applicable.
CanPost	Boolean	Boolean indicating if the authenticated user can post of the page for the page.
IsPublished	Boolean	Boolean indicating if the page for the page has been published.
IsCommunityPage	Boolean	Boolean indicating if this is a community page.
PublicTransit	String	The public transit available for the page, if any.
ParkingStreet	Boolean	Boolean indicating if street parking is available.
ParkingLot	Boolean	Boolean indicating if a parking lot is available.
ParkingValet	Boolean	Boolean indicating if valet parking is available.
PromotionEligible	Boolean	Boosted posts eligibility status. Requires the manage_pages permission and you must be an administrator of the page.
PromotionIneligibleReason	String	Reason boosted posts are not eligible. Requires the manage_pages permission and you must be an administrator of the page.
Founded	String	When the company is founded. Applicable to companies.
Mission	String	The company mission. Applicable to companies.
Products	String	The products of this company. Applicable to companies.
Hours	String	An aggregate for the hours of operation. Applicable to businesses and places.
Attire	String	Dress code of the business. Applicable to restaurants or nightlife. Valid values are Casual, Dressy or Unspecified.
AcceptsCashOnly	Boolean	Whether the business accepts only cash as a payment option. Applicable to restaurants or nightlife.
AcceptsVisa	Boolean	Whether the business accepts Visa as a payment option. Applicable to restaurants or nightlife.
AcceptsAmericanExpress	Boolean	Whether the business accepts American Express as a payment option. Applicable to restaurants or nightlife.
AcceptsMasterCard	Boolean	Whether the business accepts MasterCard as a payment option. Applicable to restaurants or nightlife.
AcceptsDiscover	Boolean	Whether the business accepts Discover as a payment option. Applicable to restaurants or nightlife.
PriceRange	String	Price range of the business. Applicable to restaurants or nightlife. Valid values are \$ (0-10), \$\$ (10-30), \$\$\$ (30-50), \$\$\$\$ (50+), or Unspecified.
TakesReservations	Boolean	Whether the restaurant takes reservations. Only applicable to restaurants.
AllowsWalkins	Boolean	Whether the restaurant allows walk-ins. Only applicable to restaurants.
AllowsGroups	Boolean	Whether the restaurant accommodates groups. Only applicable to restaurants.
AllowsKids	Boolean	Whether the restaurant allows kids. Only applicable to restaurants.
ProvidesTakeout	Boolean	Whether the restaurant provides a takeout service. Only applicable to restaurants.
ProvidesDelivery	Boolean	Whether the restaurant provides a delivery service. Only applicable to restaurants.
ProvidesCatering	Boolean	Whether the restaurant provides a catering service. Only applicable to restaurants.
HasWaiters	Boolean	Whether the restaurant has waiters. Only applicable to restaurants.
HasOutdoorSeating	Boolean	Whether the restaurant has outdoor seating. Only applicable to restaurants.
ServesBreakfast	Boolean	Whether the restaurant serves breakfast. Only applicable to restaurants.
ServesLunch	Boolean	Whether the restaurant serves lunch. Only applicable to restaurants.
ServesDinner	Boolean	Whether the restaurant serves dinner. Only applicable to restaurants.
ServesCoffee	Boolean	Whether the restaurant serves coffee. Only applicable to restaurants.
ServesDrinks	Boolean	Whether the restaurant serves drinks. Only applicable to restaurants.
CulinaryTeam	String	Culinary team of the business. Applicable to restaurants or nightlife.
PharmaSafetyInfo	String	Pharmacy safety information. Applicable to pharmaceutical companies.
Affiliation	String	Affiliation of this person. Applicable to pages representing people.
Birthday	String	Birthday of this person. Applicable to pages representing people.
PersonalInfo	String	Personal information. Applicable to pages representing people.
PersonalInterests	String	Personal interests. Applicable to pages representing people.
ArtistsWeLike	String	Artists the band likes. Applicable to bands.
BandInterests	String	Band interests. Applicable to bands.
BandMembers	String	Members of the band. Applicable to bands.
Bio	String	Biography of the band. Applicable to bands.
BookingAgent	String	Booking agent of the band. Applicable to bands.
GeneralManager	String	General manager of the business. Applicable to restaurants or nightlife. Applicable to bands.
Hometown	String	Hometown of the band. Applicable to bands.
PressContact	String	Press contact information of the band. Applicable to bands.
RecordLabel	String	Record label of the band. Applicable to bands.
Awards	String	Awards information for the film or TV show. Applicable to films and TV shows.
DirectedBy	String	The director of the film or TV show. Applicable to films and TV shows.
Genre	String	The genre of the film or TV show. Applicable to films and TV shows.
Influences	String	Influences on the band. Applicable to bands.
PlotOutline	String	The plot outline of the film or TV show. Applicable to films and TV shows.
ProducedBy	String	The productor of the film. Applicable to films.
ReleaseData	String	The film's release data. Applicable to films and TV shows.
ScreenplayBy	String	The screenwriter of the film. Applicable to films and TV shows.
Starring	String	The cast of the film or TV show. Applicable to films and TV shows.
Studio	String	The studio for the film production. Applicable to films.
Network	String	The network the TV show airs on. Applicable to TV shows.
Schedule	String	The air schedule of the TV show. Applicable to TV shows.
Season	String	The current season of the TV show. Applicable to TV shows.
WrittenBy	String	The writer of the TV show. Applicable to TV shows.
Built	String	The information about when the vehicle was built. Applicable to vehicles.
Features	String	Features of the vehicle. Applicable to vehicles.
MPG	String	Miles per gallon for the vehicle. Applicable to vehicles.
Members	String	Members of this org. Applicable to pages representing team orgs.
InstagramBusinessAccountId	String	The business instagram account id associated with this page.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source. For more information, see the WHERE clause section.

Name	Type	Description
offset	String	Which result to begin returning results from. Used for manual paging of results.

Query the Permissions the User has granted the current application.

Columns

Name	Type	Description
PermissionName [KEY]	String	The name of the permission.
Status	String	The status of the requested permission.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Facebook Ads.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Facebook Ads, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Facebook Ads Stored Procedures

Name	Description
AddCustomAudienceUsers	Updates a custom audience to add the specified users.
CreateAdInsightsReport	Generates a report schema for ad insights.
CreateAdPreview	Creates a schema file for an app insight.
DeleteCustomAudienceUsers	Deletes a specified set of users from a custom audience.

Updates a custom audience to add the specified users.

Procedure Specific Info

Configuration

Interacting with custom audience users requires configuring both a schema and payload. The PayloadSchema maps out the PII that will be represented in PayloadData.

PayloadSchema can be set as a single key, resulting in a 1-dimensional array in PayloadData:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='123456789123456789',
	@PayloadSchema='EMAIL_SHA256',
	@PayloadData='["31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66", "7df7e024c945682f00f2c6410593f407dec0e870af2a9147a62ac459db35d6b8", ...]'

PayloadSchema can also be set as a JSON array with multiple keys, resulting in a 2-dimensional array in PayloadData:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "LN"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman"
					],
					[
						"[email protected]",
						"Exampletoo"
					],
					...
				  ]'

To apply the "Limited Data Use" flag to users, it should be specified with the special "DATA_PROCESSING_OPTIONS" key in PayloadSchema, and must be provided as a nested array member in PayloadData. If using LDU and non-LDU rows in the same payload, an empty array should be used where LDU is disabled:

EXECUTE AddCustomAudienceUsers 
	@CustomAudienceId='120208749119170125',
	@PayloadSchema='["EMAIL", "DATA_PROCESSING_OPTIONS"]', 
	@PayloadData='[
					[
						"[email protected]",
						"Exampleman",
						["LDU"]
					],
					[
						"[email protected]",
						"Exampletoo",
						[]
					],
					...
				  ]'

Session Management

Facebook Ads only allows a maximum of 10000 users to be added to a custom audience in a single request. If more than 10000 (or PageSize, if set) rows are present in PayloadData, the Cloud will break the provided PayloadData down into multiple requests. Note that the SessionId parameter must be set in this case.

Hashing and Normalization

Facebook Ads has strict hashing and normalization rules for Customer File Custom Audience User information submitted through the API. The Cloud will handle hashing data (where appropriate) if the HashData parameter is set to true, but not normalizing data. See the Facebook Ads API docs for more information on the necessary data normalization.

Note: For single-key schema, only pre-hashed datatypes (E.G. 'EMAIL_SHA256') are supported by the Facebook Ads API. The Cloud expects these data types to already be hashed when provided.

Input

Name	Type	Description
CustomAudienceId	String	The ID of the custom audience to add users to.
PayloadSchema	String	Type of information represented by PayloadData. Should be either a single string, or a JSON array with multiple key types. Supported key types are: EXTERN_ID, EMAIL, PHONE, GEN, DOBY, DOBM, DOBD, LN, FN, FI, CT, ST, ZIP, MADID, COUNTRY
PayloadData	String	JSON array containing keys for each user to add to custom audience. If using multiple key types in schema, should be a two-dimensional array, with each row containing multiple keys in order specified in PayloadSchema.
PayloadAppIds	String	JSON array of integer app IDs used by users being uploaded. Required if PayloadSchema is a Facebook UID and the IDs were collected by an app integration.
PayloadPageIds	String	JSON array of integer page IDs used by users being uploaded. Required if schema is a Facebook UID and the IDs were collected by a Page webhook integration.
PayloadDataSourceType	String	Type of the underlying custom audience. Supported values are: UNKNOWN, FILE_IMPORTED, EVENT_BASED, SEED_BASED, THIRD_PARTY_IMPORTED, COPY_PASTE, CONTACT_IMPORTER, HOUSEHOLD_AUDIENCE
PayloadDataSourceSubType	String	SubType of the underlying custom audience. Supported values are: ANYTHING, NOTHING, HASHES, USER_IDS, HASHES_OR_USER_IDS, MOBILE_ADVERTISER_IDS, EXTERNAL_IDS, MULTI_HASHES, TOKENS, EXTERNAL_IDS_MIX, HOUSEHOLD_EXPANSION, SUBSCRIBER_LIST, WEB_PIXEL_HITS, MOBILE_APP_EVENTS, MOBILE_APP_COMBINATION_EVENTS, VIDEO_EVENTS, WEB_PIXEL_COMBINATION_EVENTS, PLATFORM, MULTI_DATA_EVENTS, IG_BUSINESS_EVENTS, STORE_VISIT_EVENTS, INSTANT_ARTICLE_EVENTS, FB_EVENT_SIGNALS, FACEBOOK_WIFI_EVENTS, AR_EXPERIENCE_EVENTS, AR_EFFECTS_EVENTS, MESSENGER_ONSITE_SUBSCRIPTION, WHATSAPP_SUBSCRIBER_POOL, MARKETPLACE_LISTINGS, AD_CAMPAIGN, GROUP_EVENTS, ENGAGEMENT_EVENT_USERS, CUSTOM_AUDIENCE_USERS, PAGE_FANS, CONVERSION_PIXEL_HITS, APP_USERS, S_EXPR, DYNAMIC_RULE, CAMPAIGN_CONVERSIONS, WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS, MOBILE_APP_CUSTOM_AUDIENCE_USERS, COMBINATION_CUSTOM_AUDIENCE_USERS, VIDEO_EVENT_USERS, FB_PIXEL_HITS, IG_PROMOTED_POST, PLACE_VISITS, OFFLINE_EVENT_USERS, EXPANDED_AUDIENCE, SEED_LIST, PARTNER_CATEGORY_USERS, PAGE_SMART_AUDIENCE, MULTICOUNTRY_COMBINATION, PLATFORM_USERS, MULTI_EVENT_SOURCE, SMART_AUDIENCE, LOOKALIKE_PLATFORM, SIGNAL_SOURCE, MAIL_CHIMP_EMAIL_HASHES, CONSTANT_CONTACTS_EMAIL_HASHES, COPY_PASTE_EMAIL_HASHES, CUSTOM_DATA_TARGETING, CONTACT_IMPORTER, DATA_FILE
HashData	String	Boolean value indicating if provider should handle hashing of data. Set to true to have the connector hash the provided data before sending to the service. Defaults to false.
SessionId	String	Session ID for upload involving more than 'PageSize' users (default of 10000). If PayloadData contains more than 'PageSize' records, set this value to a positive 64-bit integer.
PageSize	String	Number of records to include in 'PayloadData' in each request. Maximum and default of 10000.

Result Set Columns

Name	Type	Description
Result	String	Success or Failure.
NumReceived	String	Number of custom audience users received as reported by Facebook Marketing API.
NumInvalidEntries	String	Number of invalid entries in PayloadData as reported by Facebook Marketing API.
InvalidEntrySamples	String	JSON map representing samples of invalid entries.

Generates a report schema for ad insights.

Input

Name	Type	Description
ReportName	String	The name of the report.
Description	String	An optional description for the report.
Fields	String	Comma-delimited list of non-breakdown fields for your report. Available values: AccountCurrency,ActionValue,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,ConversionRateRanking,CostPerEstimatedAdRecallers,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,EstimatedAdRecallRate,EstimatedAdRecallers,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,InstantExperienceClicksToOpen,InstantExperienceClicksToStart,InstantExperienceOutboundClicks,Objective,QualityRanking,Reach,Spend,UniqueClicks,UniqueCTR,UniqueInlineLinkClicks,UniqueInlineLinkClickCounter,UniqueLinkClicksCounter The default value is AccountCurrency,AdAccountId,AdAccountName,CampaignID,CampaignName,AdSetId,AdSetname,AdId,AdName,BuyingType,Clicks,CostPerInlineLinkClick,CostPerInlinePostEngagement,CostPerUniqueClick,CostPerUniqueInlineLinkClick,CPC,CPM,CPP,Frequency,Impressions,InlineLinkClicks,InlineLinkClicksCounter,InlinePostEngagement,Reach,Spend.
Breakdowns	String	Breakdowns for your report. Available values: Age,Country,DevicePlatform,DMA,FrequencyValue,Gender,HStatsByAdvertiserTZ,HStatsByAudienceTZ,ImpressionDevice,PlacePageId,PlatformPosition,ProductId,PublisherPlatform,Region
ActionBreakdowns	String	Action breakdowns for your report. Available values: ActionCanvasComponentName,ActionCarouselCardId,ActionCarouselCardName,ActionConvertedProductId,ActionDestination,ActionDevice,ActionReaction,ActionTargetId,ActionType,ActionVideoSound,ActionVideoType
ActionCollection	String	Collections of ads actions stats to return for your report. The available values are: ActionValues, Actions, AdClickActions, AdImpressionActions, CatalogSegmentActions, CatalogSegmentValue, CatalogSegmentValueMobilePurchaseRoas, CatalogSegmentValueOmniPurchaseRoas, CatalogSegmentValueWebsitePurchaseRoas, ConversionValues, Conversions, ConvertedProductQuantity, ConvertedProductValue, CostPer15_secVideoView, CostPer2SecContinuousVideoView, CostPerActionType, CostPerAdClick, CostPerConversion, CostPerOneThousandAdImpression, CostPerOutboundClick, CostPerStoreVisitAction, CostPerThruplay, CostPerUniqueActionType, CostPerUniqueConversion, CostPerUniqueOutboundClick, InteractiveComponentTap, MobileAppPurchaseRoas, OutboundClicks, OutboundClicksCtr, PurchaseRoas, StoreVisitActions, UniqueActions, UniqueConversions, UniqueOutboundClicks, UniqueOutboundClicksCtr, UniqueVideoView15_sec, Video15_secWatchedActions, Video30_secWatchedActions, VideoAvgTimeWatchedActions, VideoContinuous2SecWatchedActions, VideoP100_watchedActions, VideoP25WatchedActions, VideoP50WatchedActions, VideoP75WatchedActions, VideoP95WatchedActions, VideoPlayActions, VideoPlayCurveActions, VideoPlayRetention0To15SActions, VideoPlayRetention20_to60SActions, VideoPlayRetentionGraphActions, VideoTimeWatchedActions, WebsiteCtr, WebsitePurchaseRoas The default value is Actions.
ActionAttributionWindows	String	A comma separated list which determines what is the attribution window for the actions. For example, 28d_click means the API returns all actions that happened 28 days after someone clicked on the ad. The default is [1d_view,7d_click]. Possible values include 1d_view, 7d_view, 28d_view, 1d_click, 7d_click, 28d_click, default. The default value is default.
DatePreset	String	An alternative to specifying the DateStart and DateEnd. A date range will automatically be calculated based on the specified preset value. The allowed values are maximum, today, yesterday, this_week_sun_today, this_week_mon_today, last_week_sun_sat, last_week_mon_sun, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month. The default value is maximum.
TimeIncrement	String	The number of days of data aggregation. An int (1-90) or one of monthly or all_days. This value splits the range or preset date into smaller increments. The default value is 90.
OutputDirectory	String	The directory where the schema file will be written. If no directory is specified, the generated report will be written to the FileData output.

Result Set Columns

Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if SchemaDirectory and FileStream is not set.