UserAccountSummaryMetrics
Get Summary Metric of User Account
Table Specific Information
Select
The add-in will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in.
- StartDate supports the '=,>,>=' operator.
- EndDate supports the '=,<,<=' operator.
- FromClaimedContent supports the '=' operator.
- PinFormat supports the '=' operator.
- AppTypes supports the '=' operator.
- MetricTypes supports the '=' operator.
- SplitFields supports the '=' operator.
- AdAccountID supports the '=' operator.
SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountSummaryMetrics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
| Name | Type | References | Description |
| OutboundClick | Integer | Total outbound click. | |
| OutboundClickRate | Decimal | Outbound Click Rate. | |
| Engagement | Integer | Total engagements. | |
| EngagementRate | Decimal | Engagement Rate. | |
| PinClick | Integer | Total pin clicks. | |
| PinClickRate | Decimal | Pin Click Rate. | |
| Impression | Integer | Total impressions. | |
| Save | Integer | Total saves. | |
| SaveRate | Decimal | Save Rate. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. |
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.
| Name | Type | Description | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. | |
| PinFormat | String | Pin formats to get data for, default is all.
The allowed values are ALL, ORGANIC_IMAGE, ORGANIC_PRODUCT, ORGANIC_VIDEO, ADS_STANDARD, ADS_PRODUCT, ADS_VIDEO, ADS_IDEA. The default value is ALL. | |
| AppTypes | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| MetricTypes | String | Metric types to get data for, default is all.
The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL. The default value is ALL. | |
| SplitField | String | How to split the data into groups. Not including this param means data won't be split.
The allowed values are NO_SPLIT, APP_TYPE, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT. The default value is NO_SPLIT. | |
| AdAccountID | String | Unique identifier of an ad account. |