Deeply API Documentation main logoDeeply API Documentation main logo textDeeply API Documentation main logo text
User GuideServer API Reference
k

Quick Start

API Quick Start Guide
Authorization
Rate Limit

Architecture

Overall Architecture
Edge Server System

Events

Events
Event Categories
List Events
GET
Get An Event
GET

Live Events

Live Events
Listen Live Events
WebSocket

Edges

Edge Server
List Edge Servers
GET
Get An Edge Server
GET
Update Edge Server
PATCH

Microphones

Mic Device
List Mic Devices
GET
Get A Mic Device
GET
Update Mic Device
PATCH

Auth

Reissue Token
GET

© 2025 Deeply Inc.

Deeply Logo Icon

Deeply API Documentation

    1. reference
    2. Events
    3. List Events

    List Events

    List All Events received from all edge servers

    GET
    /api/v1/events

    Description

    API to retrieve a list of events from all edge servers. The result is paginated based on the provided query parameters. Refer to the Event Object for more details.

    Authentication

    Access Token is required via Bearer token authentication. Refer to the Authentication section for more details.

    Response

    {
      "page": 1,
      "size": 10,
      "total_cnt": 100,
      "max_page": 10,
      "results": [
        {
          "id": "string",
          "label": {
            "id": "string",
            "name": {
              "ko": "string",
              "en": "string"
            }
          },
          "confidence": 0,
          "mic": {
            "id": "string",
            "name": "string",
            "location": {
              "latitude": -90,
              "longitude": -180
            }
          },
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ]
    }

    Request Examples

    Run In Postman

    Basic Request

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/events?page=1&size=10', {
      method: 'GET',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
      }
    });
    
    const data = await response.json();

    Request with Time Range

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/events?page=1&size=10&start=2024-01-01T00:00:00Z&end=2024-01-31T23:59:59Z', {
      method: 'GET',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
      }
    });
    
    const data = await response.json();

    Request with Mic Id / Label Id

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/events?page=1&size=10&mic_id=example_mic_id&label_id=normal_speech_female', {
      method: 'GET',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
      }
    });
    
    const data = await response.json();

    Request with Multiple Mic Ids

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/events?page=1&size=10&mic_id=example_mic_id1&mic_id=example_mic_id2', {
      method: 'GET',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
      }
    });
    
    const data = await response.json();
    Event Categories
    Get An Event

    On this page

    DescriptionAuthenticationResponseRequest ExamplesBasic RequestRequest with Time RangeRequest with Mic Id / Label IdRequest with Multiple Mic Ids

    Query Parameters

    page
    optional
    integer || 1
    size
    optional
    integer || 10
    start
    optional
    string (datetime) || null
    end
    optional
    string (datetime) || null
    mic_id
    optional
    string || null
    label_id
    optional
    string || null

    Page number for pagination (must be > 0)

    Number of items per page (must be > 0 and < 101)

    Start datetime for filtering events (ISO 8601 format)

    End datetime for filtering events (ISO 8601 format)

    Filter events by mic ID. Combine with multiple query parameters to filter multiple mic IDs

    Filter events by label ID. Combine with multiple query parameter to filter multiple label IDs