Audiences
Returns a list of audiences for the ad account.
View-Specific Information
SELECT
The provider uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the provider.
| Column | Supported Operators |
| Id | = |
| AdAccountId | = |
For example:
SELECT * FROM Audiences WHERE Id = '2542622901002'
SELECT * FROM Audiences WHERE AdAccountId = '549768233165'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The audience Id. | |
| AdAccountId | String |
AdAccounts.Id | The Id of the ad account. |
| Name | String | The name of the audience. | |
| AudienceType | String | The type of the audience.
The allowed values are ACTALIKE, ENGAGEMENT, CUSTOMER_LIST, VISITOR. | |
| Description | String | The description of the audience. | |
| RuleCountry | String | The country for the audience rule.
The allowed values are US, CA, GB. | |
| RuleCustomerListId | String | The Id of the customer list. Applicable for the CUSTOMER_LIST audience type. | |
| RuleEngagementDomain | String | The domain used for engagement targeting. | |
| RuleEngagementType | String | The type of engagement. Optional for the ENGAGEMENT audience type.
The allowed values are click, save, closeup, comment, like. | |
| RuleEvent | String | A Pinterest tag event. Optional for the VISITOR audience type.
The allowed values are pagevisit, signup, checkout, viewcategory, search, addtocart, watchvideo, lead, custom. | |
| RuleEventDataCurrency | String | The currency code, per ISO 4217. | |
| RuleEventDataLeadType | String | The lead type associated with the event data. | |
| RuleEventDataLineItemsProductBrand | String | The brand of the product. | |
| RuleEventDataLineItemsProductCategory | String | The category of the product. | |
| RuleEventDataLineItemsProductId | Integer | The Id of the product. | |
| RuleEventDataLineItemsProductName | String | The name of the product. | |
| RuleEventDataLineItemsProductPrice | String | The price of the product. | |
| RuleEventDataLineItemsProductQuantity | Integer | The quantity of the product. | |
| RuleEventDataLineItemsProductVariant | String | The variant of the product. | |
| RuleEventDataLineItemsProductVariantId | String | The Id of the product variant. | |
| RuleEventDataOrderId | String | The Id of the order. | |
| RuleEventDataOrderQuantity | Integer | The quantity of the order. | |
| RuleEventDataPageName | String | The name of the page. | |
| RuleEventDataPromoCode | String | The promotion code associated with the event. | |
| RuleEventDataProperty | String | The property associated with the event data. | |
| RuleEventDataSearchQuery | String | The search query string associated with the event. | |
| RuleEventDataValue | String | The monetary value of the product. | |
| RuleEventDataVideoTitle | String | The title of the video. | |
| RulePercentage | Integer | The percentage size of the targeted audience across Pinterest. Accepted values are 1 to 10. | |
| RulePinId | String | The Id of the pin. | |
| RulePrefill | Boolean | Indicates whether the audience rule is prefilled. Optional for the VISITOR audience type. The default is true. | |
| RuleRetentionDays | Integer | The number of days a Pinterest user remains in the audience. Optional for the ENGAGEMENT and VISITOR audience types. | |
| RuleSeedId | String | The Id of the seed audience. | |
| RuleUrl | String | The URL for the visitor audience rule. | |
| RuleVisitorSourceId | String | The Id of the conversion tag or Pinterest tag used on the website. Applicable for the VISITOR audience type. | |
| RuleEventSource | String | The event source for the visitor audience rule. Optional for the VISITOR audience type. | |
| RuleIngestionSource | String | The ingestion source for the visitor audience rule. Optional for the VISITOR audience type. Supported values are: tag, mmp, file_upload, conversions_api. | |
| RuleEngagerType | Integer | The engager type. Accepted values are 1 to 2. Optional for the ENGAGEMENT audience type. | |
| RuleCampaignId | String | The Id of the campaign. | |
| RuleAdId | String | The Id of the ad. | |
| RuleObjectiveType | String | The objective type of the ad. | |
| RuleAdAccountId | String | The Id of the ad account for the audience rule. | |
| Size | Integer | The size of the audience. | |
| Status | String | The status of the audience.
The allowed values are READY, INITIALIZING, TOO_SMALL. | |
| Type | String | Always 'audience'. | |
| CreatedTime | Datetime | The creation time as a Unix timestamp in seconds. | |
| UpdatedTime | Datetime | The last update time as a Unix timestamp in seconds. | |
| CreatedByCompanyName | String | The company that created this audience. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| OwnershipType | String | Filter audiences by ownership type.
The allowed values are OWNED, RECEIVED. |