| start_date |
str |
Metric report start date (UTC). Format: YYYY-MM-DD |
|
| end_date |
str |
Metric report end date (UTC). Format: YYYY-MM-DD |
|
| granularity |
str |
TOTAL - metrics are aggregated over the specified date range.<br> DAY - metrics are broken down daily.<br> HOUR - metrics are broken down hourly.<br>WEEKLY - metrics are broken down weekly.<br>MONTHLY - metrics are broken down monthly |
|
| columns |
[ReportingColumnAsync] |
Metric and entity columns |
|
| level |
str |
Level of the report |
|
| click_window_days |
int |
Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. |
[optional] if omitted the server will use the default value of 30 |
| engagement_window_days |
int |
Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `30` days. |
[optional] if omitted the server will use the default value of 30 |
| view_window_days |
int |
Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to `1` day. |
[optional] if omitted the server will use the default value of 1 |
| conversion_report_time |
str |
The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. |
[optional] if omitted the server will use the default value of "TIME_OF_AD_ACTION" |
| attribution_types |
[ConversionReportAttributionType] |
List of types of attribution for the conversion report |
[optional] |
| report_format |
str |
Specification for formatting report data |
[optional] if omitted the server will use the default value of "JSON" |
| campaign_ids |
[str] |
List of campaign ids |
[optional] |
| campaign_statuses |
[CampaignSummaryStatus] |
List of status values for filtering |
[optional] |
| campaign_objective_types |
[ObjectiveType] |
List of values for filtering. ["WEB_SESSIONS"] in BETA. |
[optional] |
| ad_group_ids |
[str] |
List of ad group ids |
[optional] |
| ad_group_statuses |
[AdGroupSummaryStatus] |
List of values for filtering |
[optional] |
| ad_ids |
[str] |
List of ad ids |
[optional] |
| ad_statuses |
[PinPromotionSummaryStatus] |
List of values for filtering |
[optional] |
| product_group_ids |
[str] |
List of product group ids |
[optional] |
| product_group_statuses |
[ProductGroupSummaryStatus] |
List of values for filtering |
[optional] |
| product_item_ids |
[str] |
List of product item ids |
[optional] |
| targeting_types |
[AdsAnalyticsTargetingType] |
List of targeting types. Requires `level` to be a value ending in `_TARGETING`. |
[optional] |
| metrics_filters |
[AdsAnalyticsMetricsFilter] |
List of metrics filters |
[optional] |
| any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |