Videos

The Videos endpoint allows you to retrieve a list of gate videos within a specified time range. This documentation will guide you through using the endpoint to access gate video data programmatically.

The gate video model

The gate video model contains information about gate videos captured by cameras.

Properties

  • Name
    url
    Type
    string
    Description

    The URL to access the video file.

  • Name
    cameraId
    Type
    integer
    Description

    The ID of the camera that captured the video.

  • Name
    timestamp
    Type
    string
    Description

    The timestamp when the video was captured.

  • Name
    confidenceScore
    Type
    number
    Description

    The confidence score of the detection.

  • Name
    objectId
    Type
    integer
    Description

    The ID of the detected object in the video.

GET/v2/videos

Get gate videos

This endpoint allows you to retrieve videos for a specific gate within a specified time range.

Required attributes

  • Name
    Gate
    Type
    string
    Description

    The name of the gate to retrieve videos for.

  • Name
    StartDateTime
    Type
    string
    Description

    The start date and time for the video search range (ISO 8601 format).

  • Name
    EndDateTime
    Type
    string
    Description

    The end date and time for the video search range (ISO 8601 format).

Request

GET
/v2/videos
curl -G https://api.synapticaviation.io/v2/videos \
  -H "Authorization: Bearer {token}" \
  -d Gate="G13" \
  -d StartDateTime="2023-01-01T00:00:00Z" \
  -d EndDateTime="2023-01-02T00:00:00Z"

Response

[
  {
    "url": "STORAGE_URL/20/2023-01-01-12-30-45-G13.mp4",
    "cameraId": 79,
    "timestamp": "2023-01-01T12:30:45.000Z",
    "confidenceScore": 0.95,
    "objectId": 1234
  },
  {
    "url": "STORAGE_URL/20/2023-01-01-13-15-22-G13.mp4",
    "cameraId": 79,
    "timestamp": "2023-01-01T13:15:22.000Z",
    "confidenceScore": 0.92,
    "objectId": 1235
  }
]

Error Responses

This section outlines the possible error responses from the videos endpoint.

Missing Parameters

If you omit any of the required parameters (Gate, StartDateTime, EndDateTime), you'll receive a 400 error.

Error Response

GET
/v2/videos
{
  "error": "Missing required parameters: Gate, StartDateTime, and EndDateTime are required"
}

If you're logged in, you can search for gate videos using the form below:

Authentication Required

To search for gate videos, please sign in to your account. This feature requires authentication to access the API.