Get a list of VideoClips, VideoClipTags, and a unique list of Tags based on a start and end epoch

POST /v1/videoclip/devices/tag/list

Summary

Get a list of VideoClips, VideoClipTags, and a unique list of Tags based on a start and end epoch.

Details

Request body: JSON object.

Supports an optional minutes query parameter to constrain the tag aggregation window.

Authentication

No operation-level security requirement is documented here.

Parameters

None documented here.

Request Body

Required: Yes

application/json

• deviceIDList (array<integer (int64)>, optional)
  • array of integer (int64)
    • integer (int64)
• tagIDList (array<integer (int64)>, optional)
  • array of integer (int64)
    • integer (int64)
• startEpoch (integer (int64), optional)
• endEpoch (integer (int64), optional)
• count (integer (int64), optional)
• order (string, optional)

Example

{
  "deviceIDList": [
    1
  ],
  "tagIDList": [
    1
  ],
  "startEpoch": 1711800000,
  "endEpoch": 1711800000,
  "count": 25,
  "order": "Example value"
}

Responses

200

Success

application/json

• videoClipList (array<VideoClip>, optional)
  • array of VideoClip
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • fileID (integer (int64), optional)
    • tSFileID (integer (int64), optional)
    • videoClipStatus (integer (int64), optional)
    • videoClipTypeID (integer (int64), optional)
    • videoClipParameters (string, optional)
    • localFilePath (string, optional)
    • height (integer (int64), optional)
    • width (integer (int64), optional)
    • fileSize (integer (int64), optional)
    • framesPerSecond (number (double), optional)
    • bitrate (integer (int64), optional)
    • audioStatus (integer (int64), optional)
    • startTime (integer (int64), optional)
    • startTimeMs (integer (int64), optional)
    • endTime (integer (int64), optional)
    • endTimeMs (integer (int64), optional)
    • clipLengthInSeconds (number (double), optional)
    • tagListID (integer (int64), optional)
    • creationDate (string (date-time), optional)
• videoClipTagList (array<VideoClipTagWithNames>, optional)
  • array of VideoClipTagWithNames
    • tagName (string, optional)
    • key (integer (int64), optional)
    • videoClipID (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • containerID (integer (int64), optional)
    • tagID (integer (int64), optional)
    • timestamp (integer (int64), optional)
    • timestampMs (integer (int64), optional)
    • confidence (number (double), optional)
    • creationDate (string (date-time), optional)
• tagList (array<Tag>, optional)
  • array of Tag
    • key (integer (int64), optional)
    • tagName (string, optional)
    • creationDate (string (date-time), optional)

Example

{
  "videoClipList": [
    {
      "key": 1,
      "deviceID": 201,
      "fileID": 1,
      "tSFileID": 1,
      "videoClipStatus": 1,
      "videoClipTypeID": 1,
      "videoClipParameters": "Example value",
      "localFilePath": "Example value",
      "height": 1,
      "width": 1,
      "fileSize": 1,
      "framesPerSecond": 1,
      "bitrate": 1,
      "audioStatus": 1,
      "startTime": 1,
      "startTimeMs": 1,
      "endTime": 1,
      "endTimeMs": 1,
      "clipLengthInSeconds": 1,
      "tagListID": 1,
      "creationDate": "2026-03-30T12:00:00.0000000Z"
    }
  ],
  "videoClipTagList": [
    {
      "key": 1,
      "videoClipID": 1,
      "deviceID": 201,
      "containerID": 1,
      "tagID": 1,
      "timestamp": 1,
      "timestampMs": 1,
      "confidence": 98.4,
      "creationDate": "2026-03-30T12:00:00.0000000Z",
      "tagName": "Example value"
    }
  ],
  "tagList": [
    {
      "key": 1,
      "tagName": "Example value",
      "creationDate": "2026-03-30T12:00:00.0000000Z"
    }
  ]
}