@apitraffic/express NPM

ApiTraffic helps engineering teams optimize their API implemenations.

How ApiTraffic Works

Once you’ve integrated the ApiTraffic SDK into your application, each request/response will be sent to the ApiTraffic, processed, and will then appear within your desired bucket.

From within your ApiTraffic account you will see real-time requests to your API, API analytics, the load size of the response, etc.

Visit our knowledgebase for the complete documentation.

Get Started

Sign in to ApiTraffic.
Setup the SDK for your application.

Install the SDK

npm i @apitraffic/express --save

Add Code To Application

const express = require('express');
const apiTraffic = require('@apitraffic/express')
const app = express();

app.use(apiTraffic());

Configuration

There are a two different methods for configuring the ApiTraffic SDK: 1. Parameters passed into the apiTraffic() function 2. Setting values as environment variables

These methods are not mutually exclusive, if for whatever reason you need to sent some as parameters and some as environment variables, it is ok they can be mixed.

If the same variable is set in both places, the parameters that are passed in will always supercede the environment variables.

Options

Function Param	Environment Variable	Required	Type	Details
token	API_TRAFFIC_TOKEN	Yes	String	Ingest token provided from your ApiTraffic account.
bucket	API_TRAFFIC_BUCKET	Yes	String	The bucket the data should be sent to when ingested.
interceptOutbound	API_TRAFFIC_INTERCEPT_OUTBOUND		Boolean	If outbound requests should be intercepted. This requires node 14 or above. (Default: true)