Calibre
  • Product
  • Pricing
  • Blog
  • Log in
  • Free trial
Calibre
SEOs
Avoid losing search engine ranking
Calibre
Agencies
Guarantee speed to your clients
Calibre
Product Teams
Delight your customers with speed
Calibre
Developers
Manipulate data to your needs
Calibre
Help Docs
How to make the most out of Calibre
Calibre
Changelog
Summary of new features & improvements
Calibre
Core Web Vitals Checker
Free tool
Easiest way to check your assessment
Calibre
Performance Newsletter
Best source of web platform news
Calibre

Product

  • Product Overview
  • All Features

Use Cases

  • SEOs
  • Agencies
  • Product Teams
  • Developers

Company & Resources

  • About
  • Pricing
  • Blog
  • Documentation
  • Changelog
  • Web Vitals Checker
  • Log in
  • Sign up free
  • Get Started

  • Metrics

  • Reports

  • CLI and API

    • Command Line Interface (CLI)

    • Node.js API

    • HTTP Site API

    • GraphQL API

    • API Tokens

    • Managing Sites

    • Deployments

    • Integrations

    • Pull Request Reviews

    • Retrieving metrics

    • Single Page Tests

    • Snapshots

    • Test Profiles

  • Account and Billing

  • Integrations

  • Frequently Asked Questions

  • Get Started

  • Metrics

  • Reports

  • CLI and API

    • Command Line Interface (CLI)

    • Node.js API

    • HTTP Site API

    • GraphQL API

    • API Tokens

    • Managing Sites

    • Deployments

    • Integrations

    • Pull Request Reviews

    • Retrieving metrics

    • Single Page Tests

    • Snapshots

    • Test Profiles

  • Account and Billing

  • Integrations

  • Frequently Asked Questions

  • Node.js API


    The Calibre Node.js API is an essential tool for building custom Calibre integrations. Use it to automate almost any account management or performance data-fetching task.

    Here’s a small sample of things it can do:

    • Adding a site to be monitored
    • Retrieving performance metrics for a given site
    • Tagging deployments
    • Conducting a one-off test against any public URL
    • Configuring Webhooks

    For a comprehensive guide to individual features of the Node.js API, browse the CLI and API pages found in the left-hand side navigation or read through the complete list of commands on GitHub.

    Installation

    Add Install it to your project by running:

    1npm install calibre --save
    1yarn add calibre

    Links and references

    Node.js API on GitHub

    Examples

    NPM Package

    On this page

    • Installation

    • Links and references

    Calibre logo

    Product

    Product Overview

    All Features

    Use Cases

    SEOs

    Agencies

    Product Teams

    Developers

    Resources & Free Tools

    Blog

    RSS Feed

    Changelog

    Performance Newsletter

    Open Source

    Core Web Vitals Checker

    Company

    About

    Careers

    Terms of Service

    Privacy Policy

    GDPR

    Security

    Support

    Help Docs

    API Docs

    Contact us

    Service Status

    © 2024 Calibre Analytics

    Australian Aboriginal Flag

    Calibre acknowledges the Wurundjeri Woiwurrung Clan of the Kulin Nation as the Traditional Custodians of the Country we work on. We recognise their continued connection to the land and waters, and acknowledge that they never ceded sovereignty. We pay our respects to Elders past and present.