Using components: Facebook Ads Insights Source

Use the Facebook Ads Insights source component to define Facebook Ads Insights reports to use as a source in a data flow package.


Select an existing Facebook connection or create a new one.

Source Properties

  • API version - Xplenty will use the selected API version when running the job. Facebook releases a new Facebook Marketing API version every few months and sunsets older versions of the API. You should check and update the API versions periodically.
  • Level - Select the report level (account by default).
  • Date range - Select a date range from the dropdown list of ranges. If you select custom date range..., you will be prompted to enter From date and To date. Click on either inputs and select the dates from the calendar. You can also use variables as values for the custom date range in the format yyyy-MM-dd.

    • If custom date range option was selected, Run report day by day checkbox will be displayed. When the checkbox is checked, the report will be executed for each day in the selected date range, in order to minimize data sampling. Make sure to include `date_start` and `date_stop` dimensions if checkbox is checked

  • Time breakdown - use to break the results by period. The default, All days means that one result will be returned for the entire period. Add the fields date_start and date_stop to get the period per record (in Schema, below).
  • Filtering (optional) - use to filter results based on the selected fields values. Filtering field should contain an array of filter objects. Each filter object has three fields: 'field', 'operator' and 'value'. Valid filter operators are: 'EQUAL', 'NOT_EQUAL', 'GREATER_THAN', 'GREATER_THAN_OR_EQUAL', 'LESS_THAN', 'LESS_THAN_OR_EQUAL', 'IN_RANGE', 'NOT_IN_RANGE', 'CONTAIN', 'NOT_CONTAIN', 'IN', 'NOT_IN', 'ANY', 'ALL', 'NONE' .

    • [{'field':'ad.effective_status','operator':'IN','value':['ARCHIVED']}] - will return archived ads.
    • [{field:"ad.impressions",operator:"GREATER_THAN",value:0}] - will retrieve insights only for ad objects with data (at least 1 impression).

  • Action report time - determines the report time of action stats (by impression by default). See Facebook Marketing APIs documentation for more details.
  • Report on... - by default, return the input for all ad accounts the connection has access to. You may also select specific accounts to report on.
  • Include custom conversions fields - If checked, custom conversion fields will be fetched and shown on available fields list.

Source Schema

Select the metrics, dimensions or breakdowns to use in the source. Action metrics include metrics for standard action and custom events with any of the 7 available attribution windows.

Creating packages

  1. Creating a new package in New Xplenty
  2. Creating a workflow
  3. Working in the new package designer
  4. Validating a package
  5. Using components: Amazon Redshift Source
  6. Using components: Bing Ads Source
  7. Using components: Database Source
  8. Using components: Facebook Ads Insights Source
  9. Using components: File Storage Source
  10. Using components: Google Adwords source
  11. Using components: Google Analytics Source
  12. Using components: Google BigQuery Source
  13. Using components: Google Cloud Spanner Source
  14. Using components: MongoDB Source
  15. Using components: NetSuite Source
  16. Using components: Salesforce source
  17. Using components: Rest API Source
  18. Using components: Aggregate Transformation
  19. Using components: Assert Transformation
  20. Using components: Clone transformation
  21. Using components: Cross Join Transformation
  22. Using components: Distinct Transformation
  23. Using components: Filter Transformation
  24. Using components: Join Transformation
  25. Using components: Limit Transformation
  26. Using components: Rank Transformation
  27. Using components: Sort Transformation
  28. Using components: Union Transformation
  29. Using components: Window Transformation
  30. Using components: Sample Transformation
  31. Using components: Cube transformation
  32. Using components: Amazon Redshift Destination
  33. Using components: Database Destination
  34. Using components: File Storage Destination
  35. Using components: Google BigQuery Destination
  36. Using components: Google Spanner Destination
  37. Using components: MongoDB Destination
  38. Using components: Salesforce Destination
  39. Using components: Snowflake Destination
  40. Using Components: Rest API Destination
  41. Using and setting variables in your packages
  42. System and pre-defined variables
  43. Using pattern-matching in source component paths
  44. Using ISO 8601 string functions
  45. Using Expressions in Xplenty
  46. Xplenty Functions

Feedback and Knowledge Base