Get Events API Overview

This section provides an overview of events API query usage

Event ObjectEvent Stream in Deeply System
Event Stream in Deeply System

Event Object

The Event object represents a specific event detected by an edge server in audio tracking system, such as a particular sound classified under a label with an associated confidence level. This class contains relevant information, including metadata about the event, the associated audio file, and detailed information about the microphone that recorded the sound.

Attributes

id

  • Type: string
  • Description: A unique identifier for the event.

label

  • Type: object
  • Description: Information about the label assigned to the event.

label.id

  • Type: string
  • Description: Unique ID of the label.

label.name

  • Type: object
  • Description: Localized name for the label.
    • ko (string): Korean name.
    • en (string): English name.

confidence

  • Type: float
  • Description: The confidence score (0.0 to 1.0) indicating the likelihood that the event corresponds to the specified label. Truncated to six decimal places.

mic

  • Type: object
  • Description: Information about the microphone that recorded this event.
    • id (string): The unique identifier of the microphone.
    • name (string): The name of the microphone.
    • location (object): Geographic location of the microphone.
      • latitude (number): Latitude coordinate (-90 to 90).
      • longitude (number): Longitude coordinate (-180 to 180).

created_at

  • Type: string, ISO 8601 format
  • Description: The timestamp indicating when the event was created. Uses ISO 8601 format.

updated_at

  • Type: string, ISO 8601 format
  • Description: The timestamp of the last update to the event. Uses ISO 8601 format.

Refer to Get Events API page for detailed response.