API Reference
Authenticate, call endpoints, handle errors, and build on top of the platform.
12 articles · Written for: Developers
API Basics
API reference
The hub for developers building on Metric Vault: authentication, the public analysis endpoint, the full route table, errors, limits and diagnostics.
API overview
The public Metric Vault API is an Enterprise-plan capability with one analysis endpoint, bearer-key authentication, and calls metered against your monthly credits.
Authentication
Create an mv_live_ API key with your session token, send it as a bearer token, and revoke it when it is no longer needed.
Make your first API call
A working end-to-end walkthrough from Enterprise plan to a parsed analysis response, with curl commands you can paste.
Code examples
Working curl, JavaScript and Python for every public API call, plus error handling, retries and batch processing patterns.
Endpoints
All endpoints
The complete Metric Vault route table, every path the Worker answers, with method, authentication mechanism and purpose.
POST /api/v1/analyze
The complete reference for the public analysis endpoint: authentication, request body, every response field, errors, cost and behavior.
Webhooks
The inbound Stripe webhook the platform receives, and the outbound Slack and JSON webhooks that Competitor Monitor and rank alerts send.
Internal endpoints
The operator-only routes protected by MV_INTERNAL_SECRET, what each one does, and why they fail closed with 503 when the secret is not set.
Errors & Limits
Error codes
Every error code and HTTP status the Metric Vault API returns, with the exact message, what caused it, and what to do about it.
Rate limits and quotas
The hourly fair-use limit, the monthly credit quota, and every payload, pagination and timeout cap that applies to an API call.
Diagnostic endpoints
Every /api/diag/ probe and the raw data-provider debug route, what each one checks, what it costs to call, and how to read the output.