## Pinterest and General API Terminology

Term	Usage	Definition
Account	General and Pinterest-specific use	Pinterest uses “Account” to refer to a person’s collection of content on Pinterest, including personal details such as login email address, billing information, settings, etc. An “account” may refer to a personal account or a business account.
Ad	General and Pinterest-specific use	Pinterest uses "Ad" to refer to a promoted Pin. An ad is created based on an existing Pin, but will have a unique `ad_id`, whereas the Pin it is created from will have a unique `pin_id`. Ads are part of the ad account (see above) structure, which includes ad campaigns (see below) and ad groups (see below). Note that while multiple ads can be created from a single Pin, each ad will have a unique `ad_id`. A given ad group can contain only one ad generated from a given Pin.
Ad Account	Pinterest Use	A type of Pinterest account specifically designed to manage advertising. Ad accounts contain ad campaigns (see below).
Ad campaign	General and Pinterest-specific use	An ad campaign is an advertising entity that businesses can create to drive traffic to their site, drive conversions, or build brand awareness. An ad campaign must belong to an ad account (see above), and consists of a set of one or more ad groups (see below), each containing one or more ads (see above).
Ad group	General and Pinterest-specific use	An ad group is a container representing a specific set of ads that have been grouped together as part of an ad campaign, along with targeting options for how those ads should be shown. Each ad group must belong to a particular ad campaign (see above) and will contain one or more ads (see above).
Alpha release or alpha access feature	Pinterest use	A feature in alpha release is one that is made available to a limited subset of customers to assist in testing and finalizing the feature. If there is a feature in alpha release that you would like to access, please contact Customer Service as described in Getting Help.
API	General use	Application Programming Interface
Application Programming Interface	General use	A tool that allows one program to communicate with another
Application ID (App ID)	Pinterest-specific use	The unique ID for a specific application; see also Client ID.
Batch	General use	A batch is a set of one or more items to be created, updated, or deleted as part of a catalogs/items/batch request. In addition to creating, updating, or deleting items via a batch, you can request the status of a batch request.
Beta release or beta access feature	Pinterest use	A feature in beta release may be: a feature that is made available to a subset of customers who request access in order to fine-tune the feature before a more general release a feature that is generally available but is still being finalized, that you may choose to use if you wish. If there is a feature in a limited beta release that you would like to access, please contact Customer Service as described in Getting Help.
Board	Pinterest use	The place where Pinners (see below) collect and organize their Pins (see below). Boards are often organized into board subsections (see below) to group pins on particular topics together. Pinners can have multiple boards.
Board Subsection	Pinterest use	A named section of a Pinterest board (see above), generally used to group Pins on particular topics together. A board can have multiple subsections.
Business Access	Pinterest use	A Business Account owner may grant "business access" to specific employees and/or partners, allowing them to perform certain functions otherwise not available to them. Please see Share and manage access to your ad accounts or Understanding Business Access for more information.
Business Access User	Pinterest use	A Pinterest user (see below; also called Pinner, see below) who has been granted access to one or more of another Pinner’s Ad accounts.
Business Account	Pinterest use	A type of Pinterest account specifically designed for businesses. This includes managed advertisers, small businesses and creators. All ad campaigns exist within a business account. A business account may or may not be linked to a personal account. A business account is allowed to create ads, ad groups, ad campaigns, and ad accounts. (see definitions above.) A business account has its own boards (see above) and Pins (see below).
Call (AKA “Request”)	General use	The structure used to request an action via an API
Catalog	General use	A catalog describes your products and their attributes. It may be reflected in one or more feeds.
Catalogs	Pinterest use	Pinterest’s Catalogs tool is a feed ingestion tool designed for businesses that sell products on their websites. It allows you to provide a data feed that contains a list of your products and their attributes.
Client ID	General use -- particularly for OAuth	The ID used to identify the requester in the OAuth process; for a Pinterest application, this is the application ID
Data Source	General use	See "Feed"
dollars	Pinterest use (advertising, analytics)	The currency selected in the advertiser’s profile; if no currency is selected, it will default to US dollars.
Engagement	General use	Any activity in which a user interacts with one of your Pins. This includes saves, Pin clicks, and outbound clicks, and carousel card swipes.
Engagement rate	Pinterest and General use	The total engagements with your Pins divided by the total number of times your Pins were seen.
Engagements	Pinterest and General use	The total number of engagements on your Pins. This includes saves, Pin clicks, outbound clicks, and carousel card swipes.
Feed	General use	A feed, also sometimes called a product feed, catalog feed, or data source, is a file that lists your products and their attributes. This is then used to update your product information on Pinterest.
Impressions	Pinterest and general use	The number of times your Pins or ads were on screen.
Ingest/Ingestion	General use	Ingestion is the process of moving the data from the source (the feed) to Pinterest for processing. Once the feed has been ingested, the data may then be processed and displayed on Pinterest.
Item	General and Pinterest-specific use	You’ll see the terms “items” and “item_id” used in our documentation. An item is simply a product that can be sold – each specific product will have its own item_id. For example, a t-shirt might come in a variety of colors and sizes, and each color-and-size variation would have its own `item_id`. This allows you to set different standard or sale prices for each variation.
Item Attribute(s)	General and Pinterest-specific use	“Item attributes” are the information that is available in Pinterest about the item in question, such as the item name, item id, size, color, description, price, etc.
Linked Business Account	Pinterest use	Linked Business Account (LBA) refers specifically to a business account (see above) that is linked to a personal account (see below).
microdollars	Pinterest use (advertising, analytics)	Microdollars are a unit used to track very small transactions. Pinterest defines a microdollar as one one-millionth of a dollar, or one one-millionth of the currency selected in the advertiser’s profile, if any. (One microdollar = 0.000001 standard currency unit)
Operating `user_account`	Pinterest use	The operating `user_account` is usually the account of the user who is logged in and making the request. However, under some circumstances, a user who has business access to another user’s account can act on that user’s behalf, and then the operating `user account` is the other user’s account. (Please see Understanding Business Access.)
Outbound click	Pinterest use	The number of times people perform actions that lead them to a destination off Pinterest.
Outbound click rate	Pinterest use	The total number of clicks to the destination URL associated with your Pi divided by the total number of times your Pins were on screen.
Personal Account	Pinterest use	A type of Pinterest account that is designed primarily for non-business, non-advertising use. A creator, business, or advertiser may have a personal account in addition to a business account; the personal account may or may not be linked to a business account, if any. A personal account has no advertising functionality.
Pin	Pinterest use (advertising, analytics)	Images, videos, and products saved or published on Pinterest. Pins belong to a board and may belong to a board subsection (see above). A Pin is not an ad; a Pinner reaches a Pin either independently or because it is shown to them on their Home Feed (if it’s relevant to their interests). Ads may be created based on Pins.
Pin clicks	Pinterest use	The total number of clicks on your Pin or ad to content on or off of Pinterest.
Pin click rate	Pinterest use	The total number of clicks on your Pin or ad to content on or off Pinterest divided by the total number of times your Pins or ads were on screen.
Pinner	Pinterest use	A person with a user account (see below) on Pinterest. (Also called “user”.)
Product Group	Pinterest and General use	A product group is a merchant-defined or automatically-defined collection of products that can be promoted together as part of an ad campaign or highlighted as a group on the merchant's Pinterest profile under the "Shop" tab. Product groups are defined by filters that determine which products will be included in the product group.
Promoted Pin	Deprecated Former Pinterest use	Deprecated A deprecated way to refer to an ad (see above).
Request (AKA “Call”)	General use	The structure used to request an action via an API
Response	General use	The structure the API sends in response to a request, either completing the action (GET), confirming the completion of the action (PUT, POST, PATCH, DELETE), or providing an error message if the action cannot be completed
RESTful API	General use	An API that is designed using Representational state transfer. RESTful APIs are designed around principles such as statelessness and cacheability.
Saves	Pinterest use	The number of times people saved your video Pin to a board.
Save rate	Pinterest use	The total saves of your Pins divided by the total number of times your Pins were on screen.
Special access feature	Pinterest use	A special access feature is available to only a limited subset of customers, based on their use cases. If there is a special access feature that you would like to access, please contact Customer Service as described in Getting Help and describe your use case.
Standard Access	Pinterest use	Standard Access is granted to an app on request, after trial access and provided there are no violations of the Pinterest developer guidelines. Pins created by apps in standard access can be distributed or promoted. For more information, please see Getting Access.
Trial Access	Pinterest use	Trial Access functions as an entry environment for developers interested in exploring the API and its functionality. Pins created by apps in trial access are only visible to the creator and cannot be promoted. For more information, please see Getting Access.
User	Pinterest use, general use	A person with a user account (see below) on Pinterest. (also called a “Pinner” - see above.)
User Account	Pinterest use, general use	A person’s account on Pinterest -- may be a personal account (see above) or a business account (see above). One person may have both a personal and a business account, and those accounts may or may not be linked (see "linked business account" above).

## Definitions for terms used in the API calls or responses

Term	Context	Definition
`ad_account_id`	Analytics Query parameters (columns)	The unique identifier associated with a given ad account
`ad_group_entity_status`	Analytics Query parameters (columns)	The status of given ad group -- running, paused, not started, completed, advertiser disabled, or archived
`ad_group_id`	Analytics Query parameters (columns)	The unique identifier associated with a given ad group
`ad_id`	Analytics Query parameters (columns)	The unique identifier associated with a given ad
`app_types`	User account analytics query	This enum allows you to filter by app or device type. It may be set as “all”, “mobile”, “tablet”, or “web”.
`availability`	List items, Create or update items	Availability of the item being listed, created, or updated. This enum may be “IN_STOCK”, “OUT_OF_STOCK”, “UNAVAILABLE”, or “PRE-ORDER”
`batch_id`	List items, Create or update or delete items, Get Batch Status	Unique ID for the specific batch in question
`bookmark`	Get Feeds	This is the value, returned with each response, to be included in the next request in order to get the next ‘page’ of values
`campaign_entity_status`	Analytics Query parameters (columns)	The status of a given campaign -- active, paused, or archived
`campaign_id`	Analytics Query parameters (columns)	The unique identifier associated with a given advertising campaign
`checkout_roas`	Analytics Query parameters (columns)	The total return on ad spend for each checkout
Click through rate	Analytics Query parameters (columns)	See ctr and ctr_2
`click_window_days`	Ad account analytics, campaigns, ad groups, and ad analytics queries	The click_window_days value sets the number of days to use as the conversion attribution window for a pin click action -- that is, the number of days during which a conversion can be attributed to a pin click. The default value is 30 days; available values are 1, 7, 30, and 60 days.
`completed_time`	List items, Create or update or delete items, Get Batch Status	Timestamp for the completion of the batch
`conversion_report_time`	Ad account analytics, campaigns, ad groups, and ad analytics queries	Conversion metrics can be reported by either the date the user interacted with the ad (`time_of_ad_action`) the date the user completed a conversion event (`time_of_conversion`). For instance, if a user clicks on an ad on, say, Friday of week 1, but converts on the site on Monday of week 2, the conversion will be reported differently depending on the selection made: If `time_of_ad_action` is selected, the conversion will be reported for the week the ad was clicked (week 1). If `time_of_conversion` is selected, the conversion will be reported for the week the conversion took place (week 2). The default is `time_of_conversion`.
`country`	Get Feeds, Get Feed, Create Feed, Update Feed List items, Create or update or delete items, Get Batch status	ISO two-character country code
`cpm_in_dollar`	Analytics Query parameters (columns)	The cost per one thousand impressions, reported in a value based on the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`created_at`	Get Feeds, Get Feed, Create Feed, Update Feed	The date and time the feed was created.
`created_time`	List items, Create or update items, Get Batch Status	Timestamp for the creation of the batch
`credentials`	Get Feeds, Get Feed, Create Feed, Update Feed	The credentials necessary to access the data source (if credentials are required).
`ctr`	Analytics Query parameters (columns)	The click-through rate on paid ads, defined as total number of ad clicks divided by total number of ad views..
`ctr_2`	Analytics Query parameters (columns)	Click-through rate for “organic” clicks -- that is, clicks on original Pins rather than on ads (the “_2” suffix indicates “organic” content)
`default_availability`	Get Feeds, Get Feed, Create Feed, Update Feed	This enum may be “IN_STOCK”, “OUT_OF_STOCK”, “UNAVAILABLE”, or “PRE-ORDER”
`default_currency`	Get Feeds, Get Feed, Create Feed, Update Feed	This is the ISO alphabetic currency code for the currency. if an item does not have a currency defined, this currency will be used
`description`	List items, Create or update items	Description of the product being listed, created, or updated
`ecpc_in_dollar`	Analytics Query parameters (columns)	The effective cost per click (including both ad clicks and organic clicks), measured in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`ecpcv_in_dollar`	Analytics Query parameters (columns)	The effective cost per completed view reported in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`ecpcv_p95_in_dollar`	Analytics Query parameters (columns)	The effective cost per completed view (95%+viewed) reported in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`ecpe_in_dollar`	Analytics Query parameters (columns)	The effective cost per engagement -- that is, on engagements with both paid ads and organic (original) Pins -- reported in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`ecpv_in_dollar`	Analytics Query parameters (columns)	The effective cost per view reported in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`ectr`	Analytics Query parameters (columns)	The effective click-through rate -- that is, the combined rate on both paid ads and organic (original) Pins.
`eengagement_rate`	Analytics Query parameters (columns)	The "eengagement rate" is the effective engagement rate, defined as the sum of all engagements (click, save, closeup, carousel sideswipe), whether paid or organic, divided by total impressions (both paid and organic). Compare to `engagement_rate`.
`engagement_rate`	Analytics Query parameters (columns)	The engagement rate is defined as the paid engagements (click, save, closeup,carousel sideswipe) divided by the paid impressions. Compare to `eengagement_rate`
`engagement_window_days`	Ad account analytics, campaigns, ad groups, and ad analytics queries	Number of days to use as the conversion attribution window for an engagement action -- that is, the number of days during which a conversion can be attributed to an engagement (saves, closeups, link clicks, and carousel card swipes). The default value is 30 days; available values are 1, 7, 30, and 60 days.
`entity_statuses`	Campaigns, ad groups, ad analytics queries	A query parameter that can be set to “active”, “paused”, or “archived”. Note that there are only three accepted values for the query parameter.
`from_claimed_content`	User account analytics query	This enum allows you to filter for Pins that match your claimed domain. It may be set as “other”, “claimed”, or “both”.
`granularity`	Ad account analytics, campaigns, ad groups, and ad analytics queries	The granularity level desired for the report being generated -- hour, day, week, month, or total.
`metric_types`	User account analytics query	This enum allows you to filter the type of data returned. It may be set as “engagement”, “engagement_rate”, “impression”, “outbound_click”, “outbound_click_rate”, “pin_click”, “pin_click_rate”, “save”, “save_rate”, or “all” (default is “all”).
`micro_dollar`	Analytics Query parameters (columns)	Any metrics defined as micro_dollar returns a value based on the advertiser profile's currency field. For USD, it's microdollars ($1/1,000,000, or $0.000001 -- one ten-thousandth of a cent). Otherwise, it's in microunits of the advertiser's currency. For example, if the advertiser's currency is GBP (British pound sterling), all micro_dollars fields will be in GBP microunits (1/1,000,000 British pound).
`order`	Campaigns, ad groups, ad analytics queries	The order in which to sort the items returned -- “ascending” or “descending” by ID. Note that higher-value IDs are associated with more-recently-added items.
`page_visit_cost_per_action`	Analytics Query parameters (columns)	The cost per action for each page visit
`page_visit_roas`	Analytics Query parameters (columns)	The total return on ad spend for each page visit
`pin_format`	User account analytics query	This enum allows you to filter for Pins in a given format. It may be set as “all”, “product”, “regular”, or “video”.
`privacy` (1)	List or Create Boards	This enum allows you to filter the boards requested in by their privacy setting, or to create a board with a specific privacy setting. The privacy settings available are “public”, “protected”, or “secret”.
`privacy` (2)	Update Boards	Similarly to the privacy enum for listing or creating boards, the privacy enum can be used in the body of the request to adjust the board’s privacy setting. The values available for updating boards are limited to “public” or “secret”.
`repin_rate`	Analytics Query parameters (columns)	Rate at which an item is re-pinned -- that is, saved by a user to their own board.
`spend_in_dollar`	Analytics Query parameters (columns)	The total amount spent on ad campaigns, in the currency specified in the advertiser’s profile’s currency field (or in dollars if no currency is specified).
`split_field`	User account analytics query	This allows you to split data into groups by the selected value. It may be set as “no_split” (the default), “app_type”, “content_type”, “owned_content”, “source”, “pin_format”, “conversion_type”, or “attribution_event”.
`total_checkout`	Analytics Query parameters (columns)	The total number of checkouts resulting from this engagement
`total_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	The value of the total checkouts resulting from this engagement in micro-dollars
`total_click_checkout`	Analytics Query parameters (columns)	The number of checkouts resulting from a click
`total_click_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the checkouts associated to clicks resulting from this engagement
`total_click_signup`	Analytics Query parameters (columns)	The number of signups resulting from a click
`total_click_signup_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the signups associated to clicks resulting from this engagement
`total_clickthrough`	Analytics Query parameters (columns)	The total number of clicks your ad received (this number divided by the number of times your ad was shown yields the clickthrough rate)
`total_conversions`	Analytics Query parameters (columns)	The total number of conversions
`total_engagement_checkout`	Analytics Query parameters (columns)	The total number of checkouts that can be attributed to an engagement action (that is, clicks, saves, carousel swipes, and collections’ secondary saves).
`total_engagement_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the checkouts associated with this engagement
`total_engagement_signup`	Analytics Query parameters (columns)	The total number of signups that can be attributed to an engagement action (that is, clicks, saves, carousel swipes, and collections’ secondary saves).
`total_engagement_signup_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the signups associated with this engagement
`total_impression_frequency`	Analytics Query parameters (columns)	The frequency with which a user saw an ad
`total_page_visit`	Analytics Query parameters (columns)	The total number of page visits resulting from this engagement
`total_repin_rate`	Analytics Query parameters (columns)	The rate at which a Pin is repinned, defined as (total repins)/(total impressions).
`total_signup`	Analytics Query parameters (columns)	The total number of signups resulting from this engagement
`total_signup_value_in_micro_dollar`	Analytics Query parameters (columns)	The value of the total signups resulting from this engagement in micro-dollars
`total_video_3sec_views`	Analytics Query parameters (columns)	The number of times your video ad played continuously for 3 seconds while at least 50% in view
`total_video_avg_watchtime_in_second`	Analytics Query parameters (columns)	The average length of time your video ad (or repins of your video ad) was played, defined as (number of seconds played)/(number of times video began playing), reported in seconds
`total_video_mrc_views`	Analytics Query parameters (columns)	The number of times your video ad (or repins of your video ad) played continuously for 2 seconds while at least 50% in view after being saved to another person's board
`total_video_p0_combined`	Analytics Query parameters (columns)	The number of times your video ad (or repins of your video ad) played while at least 50% in view, but did not reach 25% played.
`total_video_p100_complete`	Analytics Query parameters (columns)	The number of times your video played completely while at least 50% in view, including both the ad and the organic versions (including repins) of the Pin
`total_video_p25_combined`	Analytics Query parameters (columns)	Number of times your video ad (or repins of your video ad) reached 25% of its length, including views that skipped ahead to this point
`total_video_p50_combined`	Analytics Query parameters (columns)	Number of times your video ad (or repins of your video ad) reached 50% of its length, including views that skipped ahead to this point
`total_video_p75_combined`	Analytics Query parameters (columns)	Number of times your video ad (or repins of your video ad) reached 75% of its length, including views that skipped ahead to this point
`total_video_p95_combined`	Analytics Query parameters (columns)	Number of times your video ad (or repins of your video ad) reached 95% of its length, including views that skipped ahead to this point
`total_view_checkout`	Analytics Query parameters (columns)	The number of checkouts resulting from a view
`total_view_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the checkouts associated to views resulting from this engagement
`total_view_signup`	Analytics Query parameters (columns)	The number of signups resulting from a view
`total_view_signup_value_in_micro_dollar`	Analytics Query parameters (columns)	The value in micro-dollars of all the signups associated to views resulting from this engagement
`total_web_checkout`	Analytics Query parameters (columns)	The total web checkouts associated with the indicated ad, ad group, or campaign
`total_web_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	The value of all web checkouts in micro-dollars
`total_web_click_checkout`	Analytics Query parameters (columns)	Total number of web checkout events resulting from clicks on your ad
`total_web_click_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	Total value of web checkout events resulting from clicks on your a
`total_web_engagement_checkout`	Analytics Query parameters (columns)	Total number of web checkout events resulting from engagements with your ad
`total_web_engagement_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	Total value of web checkout events resulting from engagements with your ad
`total_web_view_checkout`	Analytics Query parameters (columns)	Total number of web checkout events resulting from views of your ad
`total_web_view_checkout_value_in_micro_dollar`	Analytics Query parameters (columns)	Total value of web checkout events resulting from views of your ad
`video_3sec_views_2`	Analytics Query parameters (columns)	The number of times the non-ad Pin version of your video ad played continuously for 3 seconds while at least 50% in view
`video_mrc_views_2`	Analytics Query parameters (columns)	The number of times your video ad played continuously for 2 seconds while at least 50% in view after being saved to another person's board. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p0_combined_2`	Analytics Query parameters (columns)	The number of times the non-ad Pin version of your video played while at least 50% in view, but did not reach 25% played. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p100_complete_2`	Analytics Query parameters (columns)	The number of times the non-ad Pin version of your video played completely while at least 50% in view. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p25_combined_2`	Analytics Query parameters (columns)	The number of times the non-ad version of your Pin played at least a quarter of the content while at least 50% in view. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p50_combined_2`	Analytics Query parameters (columns)	The number of times the non-ad version of your Pin played at least half the content while at least 50% in view. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p75_combined_2`	Analytics Query parameters (columns)	The number of times the non-ad version of your Pin played at least three quarters of the content while at least 50% in view. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`video_p95_combined_2`	Analytics Query parameters (columns)	The number of times the non-ad version of your Pin played at least 95% of the content while at least 50% in view. Note that metrics ending in “_2” refer to actions taking on an organic (non-ad) Pin.
`view_window_days`	Ad account analytics, campaigns, ad groups, and ad analytics queries	Number of days to use as the conversion attribution window for a view action -- that is, the number of days during which a conversion can be attributed to a view. The default value is 1 day; available values are 1, 7, 30, and 60 days.
`web_checkout_cost_per_action`	Analytics Query parameters (columns)	The cost per action for web checkout associated with this ad, ad group, or ad campaign
`web_checkout_roas`	Analytics Query parameters (columns)	The return on ad spend in the form of web checkouts