calibreapp.com

# Calibre Documentation

> Calibre is a web performance monitoring platform. Track Core Web Vitals, run Lighthouse audits, set performance budgets, and monitor real user performance with synthetic and real user monitoring.

## Get Started

- [Getting Started with Calibre](https://calibreapp.com/docs/get-started): Set up Calibre to monitor your website's performance with CrUX, Real User Monitoring, and Synthetic testing.
- [View Core Web Vitals for All Sites](https://calibreapp.com/docs/get-started/your-sites): Get a bird's-eye view of performance across all your Sites with Synthetic, CrUX and Real User Monitoring data.
- [Creating a Team](https://calibreapp.com/docs/get-started/teams): Learn how to create and manage Teams to divide work in Calibre.

## Synthetic

- [Synthetic Monitoring Setup Guide](https://calibreapp.com/docs/synthetic): Configure synthetic monitoring in Calibre — test environments, budgets, integrations, and interpreting results.
- [Create a Performance Budget](https://calibreapp.com/docs/synthetic/budgets): Learn how to set Performance Budgets and get notified of their status.
- [Configure Test Settings](https://calibreapp.com/docs/synthetic/test-profiles): Learn how to set up Test Profiles to emulate various conditions your customers face when browsing your products.
- [Managing monitored Page URLs](https://calibreapp.com/docs/synthetic/pages): Learn how manage your monitored pages in Calibre
- [Create a Snapshot](https://calibreapp.com/docs/synthetic/snapshots): Learn about automated Snapshots and how to run them manually.
- [Lighthouse Audits](https://calibreapp.com/docs/synthetic/audits): Learn what information Lighthouse audits provide across Performance, Accessibility, SEO and Best Practices categories.
- [Emulate PageSpeed in Calibre](https://calibreapp.com/docs/synthetic/calibre-pagespeed-differences): A guide on how Calibre differs from PageSpeed Insights and how to emulate it in Calibre
- [Identify Long JavaScript Tasks](https://calibreapp.com/docs/synthetic/long-task-timeline): Identify long tasks that took more than 50ms to execute during page load.
- [Examine Metric Trends](https://calibreapp.com/docs/synthetic/metric-page): Learn how to analyse data for a specific metric.
- [Benchmark All Pages at Once](https://calibreapp.com/docs/synthetic/pages-leaderboard): Learn how to benchmark your Pages as well as discover slowest and fastest ones.
- [Test Performance in Pull Requests](https://calibreapp.com/docs/synthetic/pull-request-reviews): Learn how to use Calibre to review Pull Requests
- [View All Metrics for a Page](https://calibreapp.com/docs/synthetic/pulse): Learn how to analyse your page's performance over time.
- [Run a Single Page Test](https://calibreapp.com/docs/synthetic/single-page-test): Learn what Single Page Tests are and how you can use them.
- [Analyse Performance Tests Results](https://calibreapp.com/docs/synthetic/snapshot-overview): Learn how to analyse web performance based on a Snapshot test.
- [Understand Test Agents Settings](https://calibreapp.com/docs/synthetic/test-agent): Learn about the Calibre’s synthetic monitoring Test Agents and their settings.
- [Troubleshoot Failing Tests](https://calibreapp.com/docs/synthetic/test-failures): Learn why your performance tests might not be completing.
- [Test Logged In Pages](https://calibreapp.com/docs/synthetic/test-logged-in-pages): Learn how to test pages accessible after logging in to your site or application.
- [Troubleshoot Missing Metrics or Audits](https://calibreapp.com/docs/synthetic/test-modes): Learn why your performance tests might be missing audits or metrics.
- [Set Up a Test Schedule](https://calibreapp.com/docs/synthetic/test-schedule): Learn how to choose how often Calibre tests your sites.
- [Troubleshoot Test Result Variability](https://calibreapp.com/docs/synthetic/test-verification): Learn how Calibre ensures that your test results are stable and reliable.
- [Analyse Third Party Impact](https://calibreapp.com/docs/synthetic/third-party-tracking): Learn how to quantify the impact of third party code on your Sites.
- [Troubleshoot Form Authentication](https://calibreapp.com/docs/synthetic/troubleshooting-form-authentication): Learn the steps to debug and address common problems with form authentication.

## Metrics

- [Metrics Guide](https://calibreapp.com/docs/metrics): Learn what crucial site speed metrics represent.
- [Largest Contentful Paint](https://calibreapp.com/docs/metrics/largest-contentful-paint): Largest Contentful Paint is a metric that reports the time at which the largest above-the-fold element was rendered.
- [Cumulative Layout Shift](https://calibreapp.com/docs/metrics/cumulative-layout-shift): Cumulative Layout Shift measures how much elements move unexpectedly during a page view session.
- [Interaction to Next Paint](https://calibreapp.com/docs/metrics/interaction-to-next-paint): Interaction to Next Paint is an experimental metric that reports the longest delay between user interaction and the browser response on the page.
- [Total Blocking Time](https://calibreapp.com/docs/metrics/total-blocking-time): Total Blocking Time is a metric that describes JavaScript main thread activity.
- [First Contentful Paint](https://calibreapp.com/docs/metrics/first-contentful-paint): First Contentful Paint is a metric that reports the time when first content becomes visible.
- [Round Trip Time](https://calibreapp.com/docs/metrics/round-trip-time): Round Trip Time (RTT) is a metric that measures the time it takes for a network request to travel from the user's browser to the server and back.
- [Time to First Byte](https://calibreapp.com/docs/metrics/time-to-first-byte): Time to First Byte reports the time between a request for a resource and the first byte arriving to the browser.

## Chrome User Experience Report

- [Track Core Web Vitals for Sites](https://calibreapp.com/docs/crux): Learn how to quickly check the overall performance of all of your Sites.
- [Compare Core Web Vitals across Pages](https://calibreapp.com/docs/crux/compare-core-web-vitals-across-pages): Learn how to benchmark your Pages based on the real user experience metrics of CrUX.
- [Analyse each Core Web Vital metric](https://calibreapp.com/docs/crux/analyse-cwv-metrics)
- [Chrome User Experience Report Dataset](https://calibreapp.com/docs/crux/chrome-user-experience-report): Everything you need to know about the Chrome User Experience Report (aka CrUX) dataset
- [View UX Distribution](https://calibreapp.com/docs/crux/view-experience-distribution): Learn what metrics subparts are, how to view and use them to quickly diagnose performance issues.
- [View Metric Subparts](https://calibreapp.com/docs/crux/view-metric-subparts): Learn what metrics subparts are, how to view and use them to quickly diagnose performance issues.

## Real User Monitoring

- [Real User Monitoring](https://calibreapp.com/docs/rum): Collect key performance metrics from your websites with Real User Monitoring.
- [Install & Configure RUM](https://calibreapp.com/docs/rum/install): How to install and configure Calibre RUM.
- [Tracking User Performance Data](https://calibreapp.com/docs/rum/tracking-user-performance-data): How Calibre RUM collects, processes and stores user performance data.

## Integrations

- [Continuous Integration and Delivery (CI/CD)](https://calibreapp.com/docs/integrations): Integrate Calibre with your CI/CD workflow to automate performance monitoring
- [GitHub Pull Request Reviews](https://calibreapp.com/docs/integrations/github-pull-request-reviews): Learn how to see the performance impact of development work before it gets released.
- [Github Actions](https://calibreapp.com/docs/integrations/github-actions): Use Calibre’s Github Action to automate performance testing of your application.
- [Pull Request Review Configuration](https://calibreapp.com/docs/integrations/pull-request-review-configuration): Advanced configuration options for Pull Request Reviews using .calibre/config.yml
- [Netlify](https://calibreapp.com/docs/integrations/netlify): Learn how to trigger Snapshots and mark releases based on Netlify deploys.
- [Slack](https://calibreapp.com/docs/integrations/slack): Learn how to send Calibre notifications to your Slack.
- [Render](https://calibreapp.com/docs/integrations/render): Learn how to automatically trigger Pull Request Reviews after a Render deployment.
- [Vercel](https://calibreapp.com/docs/integrations/vercel): Learn how to automatically trigger Pull Request Reviews after a Vercel Deployment Preview.
- [Webhooks](https://calibreapp.com/docs/integrations/webhooks): Learn how to obtain data from Calibre with Webhooks.
- [Zapier](https://calibreapp.com/docs/integrations/zapier): Learn how to automate workflows with Zapier.

## Account and Billing

- [Manage Your Profile](https://calibreapp.com/docs/account-and-billing): Learn about how update your profile in Calibre.
- [Manage Email Notifications](https://calibreapp.com/docs/account-and-billing/email-notifications): Learn about different types of email notifications Calibre can send and how to enable them.
- [Manage Your Plan and Test Usage](https://calibreapp.com/docs/account-and-billing/manage-plan-and-tests): Learn about how to manage your Calibre subscription and test usage.
- [Add and Remove Test Packs](https://calibreapp.com/docs/account-and-billing/add-and-remove-test-packs): Learn about how to add or remove Test Packs from your subscription.
- [Manage Payment and Invoice Settings](https://calibreapp.com/docs/account-and-billing/payment-and-invoice-settings): Learn about how to manage your invoice and payment settings.
- [Create and Manage User Accounts](https://calibreapp.com/docs/account-and-billing/manage-users): Learn about how to add and manage people’s access to Calibre.
- [Create and Manage API Tokens](https://calibreapp.com/docs/account-and-billing/manage-api-tokens): Learn about how to create and manage API Tokens that grant access to Calibre monitoring data.
- [Manage Organisation Settings](https://calibreapp.com/docs/account-and-billing/manage-org-settings): Learn about how to manage basic settings for your organisation.
- [Enable SAML Single Sign-On](https://calibreapp.com/docs/account-and-billing/saml-sso): Learn about using Calibre with SAML Single Sign-On available on the Company Plan.
- [Cancel Your Calibre Account](https://calibreapp.com/docs/account-and-billing/cancel-account): Learn about how to pause or cancel your Calibre subscription or delete a personal account.
- [Export Your Calibre Data](https://calibreapp.com/docs/account-and-billing/export-data): Learn about how to export your Calibre data.
- [User Roles and Permissions](https://calibreapp.com/docs/account-and-billing/user-roles-permissions): Learn about types of user roles and their permissions in Calibre.

## CLI and API

- [Command Line Interface (CLI)](https://calibreapp.com/docs/automation): Learn how to script performance testing with Calibre CLI.
- [Node.js API](https://calibreapp.com/docs/automation/node): Learn how to get started with Calibre Node.js API.
- [HTTP Site API](https://calibreapp.com/docs/automation/http-site-api): Learn how to use Calibre HTTP Site API.
- [GraphQL API](https://calibreapp.com/docs/automation/graphql): Learn how to get started with Calibre GraphQL API.
- [API Tokens](https://calibreapp.com/docs/automation/tokens): Learn how to create and manage your Calibre API tokens.
- [Managing Sites](https://calibreapp.com/docs/automation/managing-sites): Learn how to manage your Sites with Node.js API and the CLI.
- [Automating Deployments](https://calibreapp.com/docs/automation/deploys): Learn how to manage deploys with the Node.js API, CLI, HTTP Site API or GraphQL API.
- [Integrations](https://calibreapp.com/docs/automation/integrations): Learn how to manage Webhooks and Slack notifications through the Node.js API.
- [Pull Request Reviews](https://calibreapp.com/docs/automation/pull-request-reviews): Integrate any CI/CD system with Calibre.
- [Retrieving metrics](https://calibreapp.com/docs/automation/retrieving-metrics): Learn how to retrieve metrics for sites and pages
- [Single Page Tests](https://calibreapp.com/docs/automation/single-page-tests): Learn how to conduct and retrieve results of Single Page Tests.
- [Automating Snapshots](https://calibreapp.com/docs/automation/snapshots): Learn how to automate Snapshot creation and management.
- [Test Profiles](https://calibreapp.com/docs/automation/test-profiles): Learn how to manipulate Test Profiles with Node.js API and the CLI.