Metrici API
API Reference for Developers and System Integrators
Welcome to the Metrici API documentation! This guide explains how to connect your own applications to Metrici. Each Metrici module has its own API reference, with every endpoint, parameter, and response described in detail, together with ready-to-run examples.
Table of Contents
- Introduction
- Before You Start
- License Plate Recognition
- QR Code Recognition
- Area Counter
- Line Counter
- Parking Place Detector
- Thermal Analyzer
1. Introduction
Metrici is a suite of intelligent video analytics software and hardware products. Besides the Metrici Web Interface, where users work with dashboards, events, reports, and settings, Metrici exposes an HTTP API that allows third-party systems to work with the same data automatically. All endpoints are called with HTTP GET and return JSON by default.
Typical uses of the API include:
- Reading detection events and statistics into your own software, reports, or dashboards.
- Adding and removing authorized vehicles or QR codes from access lists, for example from a booking or visitor management system.
- Connecting parking payment kiosks and mobile applications to calculate fees and record payments.
- Showing free parking spaces, occupancy, or people counts on displays, websites, or building management systems.
Each Metrici module has a separate API reference:
| API Reference | Base Path | Purpose |
|---|---|---|
| License Plate Recognition | /api/lpr/ | Plate detections, access control lists, groups, and parking operations |
| QR Code Recognition | /api/qr/ | QR code detections, access control lists, groups, automated actions, and detection statistics |
| Area Counter | /api/ac/ | Real-time occupancy for locations, cameras, zones, and groups, plus occupancy change events |
| Line Counter | /api/lc/ | Detection events and counters for locations, cameras, zones, and gates |
| Parking Place Detector | /api/ppd/ | Individual parking spaces, occupancy status, groups, and availability counters |
| Thermal Analyzer | /api/ta/ | People counting data from thermal cameras across locations, cameras, zones, and groups |
2. Before You Start
Before sending the first request, make sure the following are in place:
- Server address — all endpoints are relative to the address of your Metrici installation. Depending on the module, the examples write it as
YOUR_HOSTor<server>. - Locations and cameras — most endpoints filter results by location ID or camera ID. These are created in the Web Interface under Global Settings → Locations & Cameras — see Location & Cameras. Every API also has endpoints that list them.
- API Key — auto-generated by Metrici and displayed in the Web Interface under Global Settings → Application Settings — see Application Settings. It is used to sign requests to the endpoints that require authentication.