UserTopPinAnalytics
Get analytics data about a user's top pins.
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.
- SortBy supports the '=' operator.
- CreatedInLastNDays supports the '=' operator.
- NumOfPins supports the '=' operator.
- MetricTypes supports the '=' operator.
- AppType supports the '=' operator.
- PiFormat supports the '=' operator.
- FromClaimedContent supports the '=' operator.
SELECT * FROM UserTopPinAnalytics WHERE SortBy = 'IMPRESSION'
SELECT * FROM UserTopPinAnalytics WHERE AppType = 'ALL'
SELECT * FROM UserTopPinAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
| Name | Type | References | Description |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| SortBy | String | Specify sorting order for metrics.
The allowed values are ENGAGEMENT, IMPRESSION, OUTBOUND_CLICK, PIN_CLICK, SAVE. | |
| Engagement | Integer | Engagement. | |
| EngagementRate | Double | The engagement rate. | |
| Impression | Integer | Impression. | |
| OutboundClick | Integer | Outboundclick. | |
| OutboundClickRate | Integer | OUTBOUNDCLICKRATE. | |
| PinClick | Integer | PINCLICK. | |
| PinClickRate | Integer | PINCLICKRate. | |
| Save | Integer | Save. | |
| SaveRate | Integer | SAVE RATE. |
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 | |
| CreatedInLastNDays | Integer | Get metrics for pins created in the last | |
| NumOfPins | Integer | Number of pins to include, default is 10. Max is 50. | |
| 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. | |
| AppType | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| 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. | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. |