> 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/pinterest/pinterest-parameters.md).

# Pinterest - Parameters

The query parameters available to a Pinterest connector.

These are the parameters a Pinterest 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 [Pinterest - Supported Columns](/roivenue-resources/roivenue-training/roivenue-app/data/connectors-overview/list-of-connectors/pinterest/pinterest-supported-columns.md).

## Parameters

| Parameter              | Type                   | Default                       | What it does                                                                        |
| ---------------------- | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------- |
| `ReportType`           | ReportTypes            |                               | Report type to download data for. Single non-zero value from ReportTypes            |
| `Metrics`              | list of text           |                               | List of columns/metrics to retrieve                                                 |
| `Fields`               | list of text           |                               | List of fields (which are specific to each report type) to retrieve                 |
| `ClickWindowDays`      | number                 |                               | Number of days to use as the conversion attribution window for a pin click action   |
| `EngagementWindowDays` | number                 |                               | Number of days to use as the conversion attribution window for an engagement action |
| `ViewWindowDays`       | number                 |                               | Number of days to use as the conversion attribution window for a view action        |
| `ConversionReportTime` | ConversionReportTime   | ConversionReportTime.AdAction | Date by which the conversion metrics returned from this endpoint will be reported   |
| `FromClaimedContent`   | FromClaimedContent     | FromClaimedContent.Both       | Filter on Pins that match claimed domain                                            |
| `PinFormat`            | PinFormat              | PinFormat.All                 | Pin formats to get data for                                                         |
| `AppTypes`             | AppTypes               | AppTypes.All                  | Apps or devices to get data for                                                     |
| `SplitField`           | SplitField             | SplitField.NoSplit            | Way how to split the data into groups                                               |
| `Endpoint`             | EndpointType           |                               | Which endpoint to use                                                               |
| `Granularity`          | Dtos.ReportGranularity | Dtos.ReportGranularity.Day    | Granularity of retrieved data                                                       |

## ReportTypes values

| Value       | Meaning                                                                               |
| ----------- | ------------------------------------------------------------------------------------- |
| `None`      | No report type is selected                                                            |
| `User`      | User analytics (user that is connected to selected ad account - during authorization) |
| `AdAccount` | Ad account analytics                                                                  |
| `Campaigns` | All campaigns that belong to selected ad account                                      |
| `AdGroups`  | All ad groups that belong to selected ad account                                      |
| `Ads`       | All ads that belong to selected ad account                                            |
| `All`       | Encompasses all defined and future report types represented by this enum              |

## ConversionReportTime values

| Value        | Meaning                                             |
| ------------ | --------------------------------------------------- |
| `AdAction`   | The date that the user interacted with the ad       |
| `Conversion` | The date that the user completed a conversion event |

## FromClaimedContent values

| Value     | Meaning                                           |
| --------- | ------------------------------------------------- |
| `Other`   | From sources that are not on user claimed website |
| `Claimed` | From user claimed website                         |
| `Both`    | From both sources                                 |

## PinFormat values

| Value     | Meaning                            |
| --------- | ---------------------------------- |
| `All`     | All formats of pins                |
| `Product` | Pin enriched with product metadata |
| `Regular` | Regular picture pin                |
| `Video`   | Pin with video                     |

## AppTypes values

| Value    | Meaning          |
| -------- | ---------------- |
| `All`    | All app types    |
| `Mobile` | Only from mobile |
| `Tablet` | Only from tablet |
| `Web`    | Only from web    |

## SplitField values

| Value              | Meaning                                   |
| ------------------ | ----------------------------------------- |
| `NoSplit`          | No splitting will be done                 |
| `AppType`          | Splitting done by type of the application |
| `ContentType`      | Splitting done by type of the content     |
| `OwnedContent`     | Splitting done by owned content           |
| `Source`           | Splitting done by source                  |
| `PinFormat`        | Splitting done by pin format              |
| `ConversionType`   | Splitting done by type of the conversion  |
| `AttributionEvent` | Splitting done by attribution event       |

## EndpointType values

| Value   | Meaning                                                                                  |
| ------- | ---------------------------------------------------------------------------------------- |
| `Both`  | Use both endpoints as suitable by range of requested data (if report type supports that) |
| `Young` | Overrides the automatic logic and uses only "young" data endpoint                        |
| `Old`   | Overrides the automatic logic and uses only "old" data endpoint                          |

{% 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 %}