> For the complete documentation index, see [llms.txt](https://docs.roivenue.com/roivenue-resources/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roivenue.com/roivenue-resources/roivenue-training/roivenue-app/data/connectors-overview/list-of-connectors/facebook-ads/facebook-ads-parameters.md).

# Facebook Ads - Parameters

The query parameters available to a Facebook Ads connector.

These are the parameters a Facebook Ads connector's query accepts. The recommended template sets the ones it needs; the rest are only reachable by editing the connector in the Advanced Editor.

Most accounts never touch these. The page exists so that when a connector does need adjusting, what is adjustable is written down. The columns it can return are listed separately on [Facebook Ads - Supported Columns](/roivenue-resources/roivenue-training/roivenue-app/data/connectors-overview/list-of-connectors/facebook-ads/facebook-ads-supported-columns.md).

## Parameters

| Parameter                      | Type          | Default                   | What it does                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ------------------------------ | ------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ReachStartDate`               | date          |                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Fields`                       | list of text  | empty                     | Fields to be retrieved. Default behavior is to return impressions and spend.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `IncludeAdCreatives`           | true or false |                           | If set to true it will include additionally Ad creatives for given campaign ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Breakdowns`                   | text          |                           | Determines how to break down the result. For more than one breakdown, only certain combinations are available: See: Combining Breakdowns (<https://developers.facebook.com/docs/marketing-api/insights/breakdowns#combiningbreakdowns>) and the Breakdowns (<https://developers.facebook.com/docs/marketing-api/insights/breakdowns>) page. The option impression\_device cannot be used by itself.                                                                                                                                                                                                                                                                                      |
| `Sort`                         | text          |                           | Field to sort the result, and direction of sorting. You can specify sorting direction by appending "\_ascending" or "\_descending" to the sort field. For example, "reach\_descending". For actions, you can sort by action type in form of "actions:action\_type". For example, \["actions:link\_click\_ascending"]. This array supports no more than one element. By default, the sorting direction is ascending.                                                                                                                                                                                                                                                                      |
| `Level`                        | text          | "ad"                      | Represents the level of result (one of: ad, adset, campaign, account).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Filtering`                    | text          |                           | Filters on the report data. This parameter is an array of filter objects.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `ActionBreakdowns`             | text          |                           | How to break down action results. Supports more than one breakdowns. Possible values are: action\_device, action\_canvas\_component\_name, action\_carousel\_card\_id, action\_carousel\_card\_name, action\_destination, action\_reaction, action\_target\_id, action\_type, action\_video\_sound, action\_video\_type. Default value is \["action\_type"].                                                                                                                                                                                                                                                                                                                             |
| `ActionReportTime`             | text          |                           | Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with action\_report\_time=impression, you see a conversion on Jan 1st. When you query the API with action\_report\_time=conversion, you see a conversion on Jan 2nd. enum{impression, conversion, mixed}                                                                                                                                                                                                                                                                                                                                     |
| `ActionAttributionWindows`     | text          |                           | 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. If you do not provide action\_attribution\_windows 7d\_click will be used and provide under value. enum{1d\_view, 7d\_view, 28d\_view, 1d\_click, 7d\_click, 28d\_click, dda, default, skan\_view, skan\_click                                                                                                                                                                                                                                                                                                                  |
| `UseUnifiedAttributionSetting` | true or false |                           | Value that indicates if unified attribution settings should be used. When this parameter is set to true, your ads results will be shown using unified attribution settings defined at ad set level and parameter use\_account\_attribution\_setting will be ignored.                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `Reach`                        | true or false |                           | If this parameter is set to true time\_increment parameter will be set to all\_days, otherwise to 1. time\_increment parameter explanation: If it is an integer, it is the number of days from 1 to 90. After you pick a reporting period by using time\_range or date\_preset, you may choose to have the results for the whole period, or have results for smaller time slices. If "all\_days" is used, it means one result set for the whole period. If "monthly" is used, you will get one result set for each calendar month in the given period. Or you can have one result set for each N-day period specified by this param. This param is ignored if time\_ranges is specified. |
| `CheckForMissingData`          | true or false |                           | If the connector should anticipate that the report will be missing data for some Campaign/AdSet/Ad (depending on Level), check for any try to load them separately                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `Method`                       | ReportMethod  | ReportMethod.AccountLevel | How report is generated                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## ReportMethod values

| Value          | Meaning                                                                                   |
| -------------- | ----------------------------------------------------------------------------------------- |
| `AccountLevel` | Create report on account-level and hope that Facebook returns all necessary Level objects |
| `LevelLevel`   | List objects based on Level and than request the report with IDs listed in filter         |

{% hint style="danger" %}
A connector edited in the Advanced Editor stops receiving template updates. Roivenue ships improvements by updating the shared template a connector is built from, and only connectors still configured by that template pick those updates up. Once a connector is switched to advanced mode, its query and transformations belong to you.
{% endhint %}