Apitally SDK for Node.js

Apitally is a simple API monitoring and analytics tool that makes it easy to understand API usage, monitor performance, and troubleshoot issues. Get started in minutes by just adding a few lines of code. No infrastructure changes required, no dashboards to build.

Learn more about Apitally on our 🌎 website or check out the 📚 documentation.

Key features

API analytics

Track traffic, error and performance metrics for your API, each endpoint and individual API consumers, allowing you to make informed, data-driven engineering and product decisions.

Request logs

Drill down from insights to individual API requests or use powerful search and filters to find specific requests. View correlated application logs and traces for a complete picture of each request, making troubleshooting faster and easier.

Error tracking

Understand which validation rules in your endpoints cause client errors. Capture error details and stack traces for 500 error responses, and have them linked to Sentry issues automatically.

API monitoring & alerts

Get notified immediately if something isn't right using custom alerts, synthetic uptime checks and heartbeat monitoring. Alert notifications can be delivered via email, Slack and Microsoft Teams.

Supported frameworks

| Framework | Supported versions | Setup guide | | --------------------------------------------------- | --------------------- | ------------------------------------------------------ | | Express | 4.x, 5.x | Link | | Fastify | 4.x, 5.x | Link | | NestJS | 9.x, 10.x, 11.x | Link | | AdonisJS | 6.x | Link | | Hono * | 4.x | Link | | H3 | 2.x | Link | | Elysia | 1.x | Link | | Koa | 2.x, 3.x | Link | | Hapi | 21.x | Link |

* For Hono on Cloudflare Workers use our Serverless SDK instead.

Apitally also supports many other web frameworks in Python, Go, .NET and Java via our other SDKs.

Getting started

If you don't have an Apitally account yet, first sign up here. Then create an app in the Apitally dashboard. You'll see detailed setup instructions with code snippets you can copy and paste. These also include your client ID.

See the SDK reference for all available configuration options, including how to mask sensitive data, customize request logging, and more.

Express

Install the SDK:

npm install apitally

Then add the Apitally middleware to your application:

const express = require("express");
const { useApitally } = require("apitally/express");

const app = express();
app.use(express.json());

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

For further instructions, see our setup guide for Express.

Fastify

Install the SDK with the fastify-plugin peer dependency:

npm install apitally fastify-plugin

Then register the Apitally plugin with your application:

import Fastify from "fastify";
import { apitallyPlugin } from "apitally/fastify";

const fastify = Fastify({ logger: true });

await fastify.register(apitallyPlugin, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

Note: If your project uses CommonJS you need to wrap your routes in a plugin, so Apitally can detect them.

For further instructions, see our setup guide for Fastify.

NestJS

Install the SDK:

npm install apitally

Then add the Apitally middleware to your application:

import { NestFactory } from "@nestjs/core";
import { useApitally } from "apitally/nestjs";
import { AppModule } from "./app.module";

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  await useApitally(app, {
    clientId: "your-client-id",
    env: "dev", // or "prod" etc.
  });

  // ...
}

bootstrap();

For further instructions, see our setup guide for NestJS.

AdonisJS

Install the SDK:

npm install apitally

Then use the following Ace command to configure Apitally in your AdonisJS application:

node ace configure apitally/adonisjs

For further instructions, see our setup guide for AdonisJS.

Hono

Install the SDK:

npm install apitally

Then add the Apitally middleware to your application:

import { Hono } from "hono";
import { useApitally } from "apitally/hono";

const app = new Hono();

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

For further instructions, see our setup guide for Hono.

H3

Install the SDK:

npm install apitally

Then register the Apitally plugin with your application:

import { H3 } from "h3";
import { apitallyPlugin } from "apitally/h3";

const app = new H3({
  plugins: [
    apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  ],
});

For further instructions, see our setup guide for H3.

Elysia

Install the SDK:

npm install apitally

Then add the Apitally plugin to your application:

import { Elysia } from "elysia";
import { apitallyPlugin } from "apitally/elysia";

const app = new Elysia()
  .use(
    apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  )
  .get("/", () => "hello");

For further instructions, see our setup guide for Elysia.

Koa

Install the SDK:

npm install apitally

Then add the Apitally middleware to your application:

const Koa = require("koa");
const { useApitally } = require("apitally/koa");

const app = new Koa();

useApitally(app, {
  clientId: "your-client-id",
  env: "dev", // or "prod" etc.
});

For further instructions, see our setup guide for Koa.

Hapi

Install the SDK:

npm install apitally

Then register the Apitally plugin with your application:

const Hapi = require("@hapi/hapi");
const { apitallyPlugin } = require("apitally/hapi");

const init = async () => {
  const server = Hapi.server({
    port: 3000,
    host: "localhost",
  });

  await server.register({
    plugin: apitallyPlugin({
      clientId: "your-client-id",
      env: "dev", // or "prod" etc.
    }),
  });
};

init();

For further instructions, see our setup guide for Hapi.

Getting help

If you need help please create a new discussion on GitHub or email us at [email protected]. We'll get back to you as soon as possible.

License

This library is licensed under the terms of the MIT license.