Metadata API Guide#
Vision metadata is comprised of metadata frames
Metadata API Endpoints#
Analytics Web API is exposed via Ingress Controller.
The URL prefix is http://<INGRESS-HOST-IP>:<INGRESS-PORT>/emdx/
Replace the INGRESS-HOST-IP with the Jetson device IP. Replace the INGRESS-PORT with 30080 or the last value defined in Ingress configuration.
Note
URL prefix path is subject to change in future release
Metadata API Version v2#
The Metadata API has a new major version v2 which is not backward compatible with earlier version. The previous version shipped with JPS 1.0 version is still supported in this release. However it is highly recommended to adopt/migrate to v2 version. The v2 version is provided under path /api/v2. Where the earlier version is still functional under /api.
Retrieve vision metadata#
Get metadata for a given time duration for a given sensor:
HTTP GET
/api/v2/frames?sensorId=Amcrest_3&fromTimestamp=2020-10-30T20:00:00.000Z&toTimestamp=2020-10-31T01:00:00.000Z
Mandatory query parameters#
sensorId
description: Sensor for which metadata is to be returned.
type: string
example: sensorId=Amcrest_3
fromTimestamp
description: lower bound of the timestamp for which metadata needs to be returned
type: UTC / GMT timestamp string
example: 2020-10-30T20:00:00.000Z
toTimestamp
description: Upper bound of timestamp for which metadata needs to be returned.
type: UTC / GMT timestamp string
example: 2020-10-30T20:05:00.000Z
Response#
{ "frames": [ { "timestamp": "2022-08-09T21:25:13.208Z", "version": 4.0, "id": 4508668, "sensorId": "Amcrest_3", "objects": [ { "id": 899, "type": "Person", "bbox": { "leftX": 1075.61, "topY": 364.011, "rightX": 1230.41, "bottomY": 754.086 } } ] } ] }
Error Response#
Response body: See Error response body definition at the end of the page.
HTTP Status codes:
422: No metadata frames found for the requested sensorId and time range 500: Internal server error
Error Response body:#
Error response for all API is JSON object with following attributes.
{
"detail": "#Detailed error string"
}