> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/vss/_mcp/server. # Video Analytics API Reference > Request and response schemas for the Video Analytics API This reference is generated from the Video Analytics API OpenAPI specification. It includes request parameters, response schemas, and examples for every endpoint. For a self-hosted Docker Compose deployment that includes the Video Analytics API, replace the generated server URL with `http://:8081` for direct access or `http://:7777/video-analytics-api` through the VSS ingress. These are the default host ports; use the configured `VIDEO_ANALYTICS_API_HOST_PORT` or `HAPROXY_HOST_PORT` if either was overridden. Append the documented endpoint path to the selected base URL. Select an endpoint in the navigation to jump to its documentation on this page. > Request and response schemas for the Video Analytics API ## API Docs - Video Analytics API Reference > metrics [Get average speed](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-average-speed.md) - Video Analytics API Reference > metrics [Get flow rate](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-flowrate.md) - Video Analytics API Reference > metrics [Get average speed and flow rate](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-average-speed-with-flowrate.md) - Video Analytics API Reference > metrics [Get average speed and travel time](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-average-speed-with-travel-time.md) - Video Analytics API Reference > metrics [Get tripwire counts](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-tripwire-counts.md) - Video Analytics API Reference > metrics [Get tripwire-based occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-tripwire-based-occupancy.md) - Video Analytics API Reference > metrics [Reset place occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-reset-occupancy.md) - Video Analytics API Reference > metrics [Get tripwire count histogram](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-tripwire-histogram.md) - Video Analytics API Reference > metrics [Get FOV occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-fov-occupancy.md) - Video Analytics API Reference > metrics [Get FOV occupancy histogram](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-fov-histogram.md) - Video Analytics API Reference > metrics [Get ROI occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-roi-occupancy.md) - Video Analytics API Reference > metrics [Get ROI occupancy histogram](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-roi-histogram.md) - Video Analytics API Reference > metrics [Get mutually exclusive ROI occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-occupancy-based-on-mutually-exclusive-roi.md) - Video Analytics API Reference > metrics [Get tracker-based occupancy](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-occupancy-tracker.md) - Video Analytics API Reference > metrics [Get tracker occupancy histogram](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-tripwire-occupancy-histogram.md) - Video Analytics API Reference > metrics [Get space utilization histogram](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-space-utilization-histogram.md) - Video Analytics API Reference > metrics [Get last processed timestamp](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-metrics-get-last-processed-timestamp.md) - Video Analytics API Reference > metrics [Get road-segment speeds](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/metrics/controller-road-network-average-segment-speed.md) - Video Analytics API Reference > tracker [Get unique object count](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/tracker/controller-tracker-get-unique-object-count.md) - Video Analytics API Reference > tracker [Get unique object count and locations](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/tracker/controller-tracker-get-unique-object-count-with-locations.md) - Video Analytics API Reference > tracker [Get tracked objects](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/tracker/controller-tracker-get-unique-objects.md) - Video Analytics API Reference > tracker [Get behavior locations](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/tracker/controller-tracker-get-behavior-locations.md) - Video Analytics API Reference > tracker [Get the latest RTLS or AMR record](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/tracker/controller-tracker-get-last-record.md) - Video Analytics API Reference > frames [Get raw frame metadata](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-raw-frames.md) - Video Analytics API Reference > frames [Get enhanced frame metadata](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-enhanced-frames.md) - Video Analytics API Reference > frames [Get BEV frame metadata](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-bev-frames.md) - Video Analytics API Reference > frames [Get frame-based alerts](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-alerts.md) - Video Analytics API Reference > frames [Get high-confidence frame objects](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-high-confidence-objects.md) - Video Analytics API Reference > frames [Get proximity clusters](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-proximity-clusters.md) - Video Analytics API Reference > frames [Get frame PTS](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/frames/controller-frames-get-pts.md) - Video Analytics API Reference > behavior [Get behaviors](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/behavior/controller-behavior-get-behavior.md) - Video Analytics API Reference > behavior [Get behavior PTS](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/behavior/controller-behavior-get-pts.md) - Video Analytics API Reference > alerts [Get alerts](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/alerts/controller-alerts-get-alerts.md) - Video Analytics API Reference > alerts [Get severe alerts by place or sensor](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/alerts/controller-alerts-get-severe-alerts.md) - Video Analytics API Reference > incidents [Get incidents](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/incidents/controller-incidents-get-incidents.md) - Video Analytics API Reference > incidents [Get severe incidents by place or sensor](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/incidents/controller-incidents-get-severe-incidents.md) - Video Analytics API Reference > clustering [Get behavior clusters](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/clustering/controller-clustering-get-clustering-results.md) - Video Analytics API Reference > clustering [Label a behavior cluster](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/clustering/controller-clustering-add-cluster-label.md) - Video Analytics API Reference > events [Get tripwire events](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/events/controller-events-get-tripwire-events.md) - Video Analytics API Reference > events [Get AMR events](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/events/controller-events-get-amr-events.md) - Video Analytics API Reference > events [Get ROI events](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/events/controller-events-get-roi-events.md) - Video Analytics API Reference > config [Upload a configuration file](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-upload-file.md) - Video Analytics API Reference > config [Update service configuration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-update.md) - Video Analytics API Reference > config [Get configuration update status](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-update-status.md) - Video Analytics API Reference > config [Upsert sensor calibration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-upsert-calibration.md) - Video Analytics API Reference > config [Delete sensor calibration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-delete-sensor-calibration.md) - Video Analytics API Reference > config [Get calibration configuration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-calibration-config.md) - Video Analytics API Reference > config [Get calibration modification timestamp](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-calibration-last-modified-timestamp.md) - Video Analytics API Reference > config [Get road-network configuration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-road-network-config.md) - Video Analytics API Reference > config [Get USD asset configuration](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-usd-assets-config.md) - Video Analytics API Reference > config [Upload calibration images](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-upload-calibration-images.md) - Video Analytics API Reference > config [Get a calibration image](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-calibration-image.md) - Video Analytics API Reference > config [Get calibration image metadata](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-get-calibration-image-metadata.md) - Video Analytics API Reference > config [Delete calibration images](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/config/controller-config-delete-calibration-images.md) - Video Analytics API Reference > sensor [Find sensors covering a floor-plan coordinate](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/sensor/controller-sensor-get-sensor-lookup.md) - Video Analytics API Reference > livez [Check service health](https://docs.nvidia.com/vss/dev/system-components/middleware/api-gateway-mcp/video-analytics-api/video-analytics-api-reference/livez/controller-livez-is-alive.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.nvidia.com/vss/openapi.json) - [OpenAPI YAML](https://docs.nvidia.com/vss/openapi.yaml)