💻API Documentation

This section provides you with an overview of our available metrics and KPIs in Boolee.

• Click rate: clicks.click_rate - The number of unique clicks divided by the total number of successful deliveries.

• Hard bounces: bounces.hard_bounces - The total number of hard bounced email addresses.

• Number of opens: opens.opens_total - The total number of opens for a campaign.

• Number of total clicks: clicks.clicks_total - The total number of clicks for the campaign.

• Number of unique clicks: clicks.unique_clicks - The total number of unique clicks for links across a campaign.

• Number of unique opens: opens.unique_opens - The total number of unique opens.

• Open rate: opens.open_rate - The number of unique opens divided by the total number of successful deliveries.

• Unsubscribed: unsubscribed - The total number of unsubscribed members for this campaign.

Google Ads Metrics & KPI's

• Average cart size: average_cart_size - Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Average cost: average_cost - The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. (Keyword Level).

• Average cost per interaction: average_cost - The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. The average cost metric is reported in the currency of your account. (Campaign Level, Ad Level, Ad Group Level).

• Average page views: average_page_views - Average number of pages viewed per session. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Average time on site: average_time_on_site - Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Content budget lost impression share: content_budget_lost_impression_share - The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. (Campaign Level).

• Content impression share: content_impression_share - The impressions you have received on the Display Network divided by the estimated number of impressions you were eligible to receive. (Campaign Level, Ad Level, Keyword Level).

• Content rank lost impression share: content_rank_lost_impression_share - The estimated percentage of impressions on the Display Network that your ads did not receive due to poor Ad Rank. (Campaign Level, Ad Level).

• Conversion value: conversions_value - The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Cost: cost_micros - The total cost of all interactions. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Cost per conversion: cost_per_conversion - The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• CPC: average_cpc - The total cost per click of all clicks divided by the total number of clicks received. The average CPC metric is reported in the currency of your account. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• CPM: average_cpm - The average cost for 1,000 impressions. The average CPM metric is reported in the currency of your account. (Campaign Level, Ad Level, Ad Group Level).

• CTR: ctr - The Click Through Rate shows the percentage of times people saw your ad and performed a click (all). (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Current model attributed conversions: current_model_attributed_conversions - Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Current model attributed conversions from interactions rate: current_model_attributed_conversions_from_interactions_rate - Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). (Campaign Level).

• Current model attributed conversions from interactions value per interaction: current_model_attributed_conversions_from_interactions_value_per_interaction - The value of current model attributed conversions from interactions divided by the number of ad interactions. (Campaign Level).

• Current model attributed conversions value: current_model_attributed_conversions_value - The value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Current model attributed conversions value per cost: current_model_attributed_conversions_value_per_cost - The value of current model attributed conversions divided by the cost of ad interactions. (Campaign Level).

• Number of ad clicks: clicks - The number of times people clicked your ad. Note: If you're using manual bidding, you may see more clicks than conversions. (Campaign Level, Ad Level, Ad Group Level).

• Number of all conversions: all_conversions - The number of all conversions. (Keyword Level).

• Number of conversions: conversions - The number of times people took a desired action after seeing your ad. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Number of impressions: impressions - The number of times your ads were on screen. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Number of interactions: interactions - The number of interactions. An interaction is the main user action associated with an ad format—clicks for text and shopping ads, views for video ads, and so on. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Number of order clicks on any location surface after a chargeable ad event (click or impression): all_conversions_from_location_asset_order - Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. (Campaign Level).

• Number of times people placed an order at a store after clicking an ad. This metric applies to feed items only: all_conversions_from_order - The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only. (Campaign Level).

• Number of unique users: unique_users - The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for the following campaign types—Display, Video, Discovery, and App. (Campaign Level).

• Number of visits to the store after a chargeable ad event (click or impression): all_conversions_from_location_asset_store_visits - Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location. (Campaign Level).

• Number of website URL clicks on any location surface after a chargeable ad event (click or impression): all_conversions_from_location_asset_website - Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location. (Campaign Level).

• Number of website URL clicks on any location surface after a chargeable ad event (click or impression): all_conversions_from_store_website - The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only. (Campaign Level).

• Relative CTR: relative_ctr - Your clickthrough rate (CTR) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites. (Campaign Level, Ad Level).

• Return on ad spend (ROAS): conversions_value,cost_micros - The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads). It is expressed as a ratio. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Search absolute top impression share: search_absolute_top_impression_share - The percentage of the customers Shopping or Search ad impressions that are shown in the most prominent Shopping position. (Campaign Level, Ad Level, Keyword Level).

• Search budget lost absolute top impression share: search_budget_lost_absolute_top_impression_share - The number estimating how often your ad was not the very first ad above the organic search results due to a low budget. (Campaign Level, Ad Level, Keyword Level).

• Search budget lost impression share: search_budget_lost_impression_share - The estimated percent of times that your ad was eligible to show on the Search Network but did not because your budget was too low. (Campaign Level).

• Search budget lost top impression share: search_budget_lost_top_impression_share - The number estimating how often your ad did not show anywhere above the organic search results due to a low budget. (Campaign Level, Ad Level, Keyword Level).

• Search click share: search_click_share - The number of clicks you have received on the Search Network divided by the estimated number of clicks you were eligible to receive. (Campaign Level, Keyword Level).

• Search exact match impression share: search_exact_match_impression_share - The impressions you have received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. (Campaign Level, Ad Level, Keyword Level).

• Search impression share: search_impression_share - The impressions you have received on the Search Network divided by the estimated number of impressions you were eligible to receive. (Campaign Level, Ad Level).

• Search rank lost absolute top impression share: search_rank_lost_absolute_top_impression_share - The number estimating how often your ad was not the very first ad above the organic search results due to poor Ad Rank. (Campaign Level, Ad Level, Keyword Level).

• Search rank lost impression share: search_rank_lost_impression_share - The estimated percentage of impressions on the Search Network that your ads did not receive due to poor Ad Rank. (Campaign Level, Ad Level).

• Search rank lost top impression share: search_rank_lost_top_impression_share - The number estimating how often your ad did not show anywhere above the organic search results due to poor Ad Rank. (Campaign Level, Ad Level, Keyword Level).

• The total value of all conversions: all_conversions_value - The total value of all conversions. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

• Value per current model attributed conversion: value_per_current_model_attributed_conversion - The value of current model attributed conversions divided by the number of the conversions. (Campaign Level, Ad Level, Keyword Level, Ad Group Level).

Linkedin Metrics & KPI's

• Clicks: clicks - The amount of clicks, such as to view the landing page or company page. (Campaign level).

• Comments: comments - The number of comments on your ads. (Campaign level).

• Cost in local currency: costInLocalCurrency - The total amount spent on the campaign in local currency. (Campaign level).

• Follower gains: followerGains - The increase in the number of followers for your organization. (Organization level).

• Follows: follows - The number of follows gained from your ads. (Campaign level).

• Full screen plays: fullScreenPlays - The number of times your video ads were played in full screen. (Campaign level).

• Impressions: impressions - This is the count of "impressions" for Sponsored Content and "sends" for Sponsored Messaging. (Campaign level).

• Landing page clicks: landingPageClicks - The number of clicks on your ads that led to the landing page. (Campaign level).

• Likes: likes - The number of likes on your ads. (Campaign level).

• Organization button clicks: buttonClicks - Custom button click counts for your organization. (Organization level).

• Organization page views: pageViews - Views of different pages on your organization. (Organization level).

• Shares: shares - The number of times your ads were shared. (Campaign level).

• Unique organization page views: uniquePageViews - Unique views of different pages on your organization. (Organization level).

• Video completions: videoCompletions - The number of times your video ads were watched to completion. (Campaign level).

• Video views: videoViews - The number of times your video ads were viewed. (Campaign level).

Instagram Metrics & KPI's

• Negative page action: page_negative_feedback_by_type - The number of times people took a negative action (e.g., un-liked or hid a post).

• New page fans: page_fan_adds_by_paid_non_paid_unique - The number of new people who have liked your Page, broken down by paid and non-paid.

• Number of engaged users on page: page_engaged_users - The number of people who engaged with your Page. Engagement includes any click.

• Number of post engagements: page_post_engagements - The number of times people have engaged with your posts through reactions, comments, shares, and more.

• Page fans: page_fans - The total number of people who have liked your Page.

• Page fans by country: page_fans_country - The number of people, aggregated per country, that like your Page. Only the 45 countries with the most people that like your Page are included.

• Positive page action: page_positive_feedback_by_type - The number of times people took a positive action, broken down by type.

• Post likes of page: page_actions_post_reactions_like_total - Daily total post "like" reactions of a page

Google Analytics Metrics & KPI's

• Active 7 Day Users: active7DayUsers - The number of users who have engaged with the website or app in the past 7 days.

• Active Users: activeUsers - The number of users who have engaged with the website or app in the selected time period.

• Add To Carts: addToCarts - The number of times items have been added to shopping carts.

• Advertiser ad clicks: advertiserAdClicks - The number of times users have clicked on advertisements.

• Advertiser ad cost: advertiserAdCost - The total cost of advertisements.

• Advertiser ad cost per click: advertiserAdCostPerClick - The average cost of each advertisement click.

• Advertiser Ad Cost Per Conversion: advertiserAdCostPerConversion - The average cost of each conversion from advertisements. Deprecation warning: This metric is deprecated and will be removed in the future. Please use the metric advertiserAdCostPerKeyEvent instead.

• Advertiser ad cost per key event: advertiserAdCostPerKeyEvent - Cost per key event is ad cost divided by key events.

• Advertiser ad impressions: advertiserAdImpressions - The number of times advertisements have been viewed.

• Average engagement time: averageSessionDuration - Average engagement time calculated based on session durations.

• Average purchase revenue: averagePurchaseRevenue - The average revenue generated from each purchase.

• Average purchase revenue per user: averagePurchaseRevenuePerUser - The average revenue generated from each user through purchases.

• Average revenue per user: averageRevenuePerUser - Average revenue per active user (ARPU). The summary metric is for the time period selected. ARPU uses Total Revenue and includes AdMob estimated earnings.

• Bounce rate: bounceRate - The percentage of sessions that were not engaged.

• Checkouts: checkouts - The number of completed checkouts.

• Conversion (deprecated): conversions - Conversion events. You can mark any event as a conversion in Google Analytics. Deprecation warning: This metric is deprecated. Use "keyEvents" instead.

• Ecommerce purchases: ecommercePurchases - The number of times users completed a purchase. This metric counts purchase events; this metric does not count in_app_purchase and subscription events.

• Engaged sessions: engagedSessions - The number of sessions that lasted longer than 10 seconds, or had a conversion event, or had 2 or more screen views.

• Engagement rate: engagementRate - The percentage of engaged sessions (Engaged sessions divided by Sessions). This metric is returned as a fraction; for example, 0.7239 means 72.39% of sessions were engaged sessions.

• Item list click events: itemListClickEvents - The number of times users clicked on a list of items.

• Item refund amount: itemRefundAmount - The total amount refunded for items.

• Item revenue: itemRevenue - The total revenue generated from items.

• Items added to cart: itemsAddedToCart - The number of items added to the shopping cart.

• Items purchased: itemsPurchased - The number of items that have been purchased.

• Key events: keyEvents - The count of key events. Marking an event as a key event affects reports from the time of creation. It doesn't change historical data. You can mark any event as key in Google Analytics, and some events (such as 'first_open' or 'purchase') are marked as key events by default.

• New users: newUsers - The number of new users that have registered or visited the site.

• Organic google search average position: organicGoogleSearchAveragePosition - The average position of the site in organic Google search results.

• Organic Google Search Click Through Rate: organicGoogleSearchClickThroughRate - The click-through rate for organic Google search results.

• Organic google search clicks: organicGoogleSearchClicks - The number of clicks from organic Google search results.

• Percent scrolled: percentScrolled - The percentage down the page that the user has scrolled (for example, 90). Automatically populated if Enhanced Measurement is enabled. Populated by the event parameter percent_scrolled.

• Publisher Ad Clicks: publisherAdClicks - The number of clicks on publisher ads.

• Publisher ad impressions: publisherAdImpressions - The number of impressions of publisher ads.

• Purchaser conversion rate (deprecated): purchaserConversionRate - The conversion rate of purchasers. Deprecation warning: This metric is deprecated and will be removed in the future. Use the "conversionRate" metric instead.

• Return on ad spend: returnOnAdSpend - The return on ad spend.

• Scrolled users: scrolledUsers - The number of users who scrolled.

• Session conversion rate (deprecated): sessionConversionRate - The conversion rate of sessions. Deprecation warning: This metric is deprecated and will be removed in the future. Use the "sessionKeyEventRate" metric instead.

• Session key event rate: sessionKeyEventRate - The percentage of sessions in which any key event was triggered.

• Session key event rate (click): sessionKeyEventRate:click - The percentage of sessions in which a click event was triggered.

• Session key event rate (formStart): sessionKeyEventRate:form_start - The percentage of sessions in which a formStart event was triggered.

• Session key event rate (purchase): sessionKeyEventRate:purchase - The percentage of sessions in which a purchase event was triggered.

• Sessions: sessions - Number of sessions.

• Total ad revenue: totalAdRevenue - The total advertising revenue from both Admob and third-party sources.

• Total purchasers: totalPurchasers - The number of users that logged purchase events for the time period selected.

• Total revenue: totalRevenue - The total revenue.

• Total users: totalUsers - The number of distinct users who have logged at least one event, regardless of whether the site or app was in use when that event was logged.

• Transactions: transactions - The count of transaction events with purchase revenue. Transaction events are in_app_purchase, ecommerce_purchase, purchase, app_store_subscription_renew, app_store_subscription_convert, and refund.

• User conversion rate (deprecated): userConversionRate - The conversion rate of users. Deprecation warning: This metric is deprecated and will be removed in the future. Use the "userKeyEventRate" metric instead.

• User engagement: userEngagementDuration - The total amount of time (in seconds) your website or app was in the foreground of users' devices.

• Views: screenPageViews - The number of app screens or web pages your users viewed. Repeated views of a single page or screen are counted. (screen_view + page_view events).