## Enum Value Definitions

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”.
`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_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.
`conversion_report_time`	Ad account analytics, campaigns, ad groups, and ad analytics queries	Conversion metrics can be reported either by the date the user interacted with the ad (time_of_ad_action), or by 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 week 1 (when the ad was clicked). If time_of_conversion is selected, the conversion will be reported for week 2 (when the conversion took place). The default value is time_of_conversion.
`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).
`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)
`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 effective engagement rate is defined as the sum of all engagements (click, save, closeup, carousel sideswipe), whether paid or organic, divided by total impressions (both paid and organic).
`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
`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

## General API Terminology

API	General use	Application Programming Interface
Application Programming Interface	General use	A tool that allows one program to communicate with another
Call (AKA “Request”)	General use	The structure used to request an action via an API
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.

## Pinterest Terminology

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.
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.
dollars	Pinterest use (advertising, analytics)	The currency selected in the advertiser’s profile; if no currency is selected, it will default to US dollars.
Linked Business Account	Pinterest use	Linked Business Account (LBA) refers specifically to a business account that is linked to a personal account.
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)
Organic Pin	Pinterest use (advertising, analytics)	A Pin that has not been promoted (advertised)
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.
Promoted Pin	Pinterest use (advertising, analytics)	A Pin that is part of an advertising campaign
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.

Pinterest

Developers