ApiDeck Documentation
Instantly monitor your APIs and track performance metrics in real-time.
Getting Started
ApiDeck is a powerful API monitoring SDK that tracks every API call, analyzes performance metrics, and provides actionable insights. This documentation will guide you through setting up and configuring ApiDeck in your project.
Note
You'll need to sign up for an ApiDeck account to get your API key before proceeding with the installation.
Get Your API Key
1. Signup and create an APiDeck account.
2. Log in to your dashboard. Your unique apikey will be automatically generated and displayed.
3. Now use this apikey in the backend setup.
Installation
Install the ApiDeck SDK using npm, yarn:
npm install apideck-trackeryarn add apideck-trackerQuick Setup
After installation, initialize ApiDeck in your application:
import { apiTracker } from "apideck-tracker";
app.use(
apiTracker({
apikey: "YOUR_API_KEY",
trackerUrl: "https://apideck.site",
})
);
Configuration
Configure ApiDeck to match your monitoring needs.
Configuration Options
| Option | Type | Description |
|---|---|---|
| apiKey | string | Your unique API key from the ApiDeck dashboard. |
| trackerUrl | string | The backend URL where usage data is sent for logging and analytics. |
Pricing
Choose the plan that fits your monitoring needs.
Starter
- ✓Up to 1,000 requests/month
- ✓Basic analytics
- ✓7-day log retention
- ✓Access to dashboard metrics
Professional
- ✓Up to 1M API calls/month
- ✓Advanced analytics
- ✓Priority support
- ✓30 days data retention
- ✓Custom alerts
Enterprise
- ✓Unlimited API calls
- ✓Custom analytics
- ✓24/7 dedicated support
- ✓Custom data retention
- ✓SLA guarantees
FAQs
Frequently asked questions about ApiDeck.
What is ApiDeck?
ApiDeck is a comprehensive API monitoring SDK that helps you track, analyze, and optimize your API performance in real-time. It provides detailed insights into every API call, helping you identify issues before they impact your users.
How does ApiDeck track API calls?
ApiDeck integrates seamlessly into your application through our lightweight SDK. It automatically captures API requests and responses, along with performance metrics, and sends this data to your dashboard for analysis.
Can I use ApiDeck in production?
Absolutely! ApiDeck is designed for production environments. Our SDK has minimal performance overhead and includes features like sampling rates to ensure it doesn't impact your application's performance.
What languages and frameworks are supported?
ApiDeck currently supports Node.js (Express.js framework). Support for additional frameworks such as Fastify, Koa, and NestJS, as well as other languages like Python and Go, is planned for future updates.
How secure is my data?
We take security seriously. All data is encrypted in transit and at rest. We never store sensitive information like API keys or authentication tokens. You can also configure what data gets sent to ApiDeck.
Do I need to create any routes manually?
No. You only need to provide the trackerUrl of your backend where the data is collected. The SDK automatically sends POST requests to the dedicated API.