Skip to main content

List your sessions

Returns a list of your sessions. The sessions are returned sorted by creation date, with the most recent sessions appearing first.

URL

GET /v1/sessions

Request Query Parameters

state
enum SessionState
If specified, only sessions with that state will be returned.
type
enum SessionType
If specified, only sessions of that type will be returned.
from
date
Only return sessions started after that date.
to
date
Return only sessions started before that date.
limit
number
Determines the number of items per page. Accepts values between 1 and 100.
Default: 10
offset
number
Specifies the starting point for the data returned, effectively controlling the page being accessed.
Default: 0

Response Body

hasMore
boolean
A boolean indicating whether there are additional pages of data available after the current page.
Example: true
offset
number
The index of the first item on the current page, relative to the full dataset.
Example: 20
limit
number
The maximum number of items returned in each page.
Example: 10
data
object/Session[]
List of sessions matching specified filters.

Response codes

CodeMeaningDescription
200OKThe request has succeeded. The client can read the result in the body.
400Bad RequestServer received an invalid request body or invalid query parameters.

Request example

curl -X GET 'https://api.emogg.com/v1/sessions' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Example response

{
    "hasMore": true,
    "offset": 20,
    "limit": 10,
    "data": [
        {
            "_id": "65ea1530bb50af72b6e3dc1e",
            "name": "Mobile Word Congress Pitch",
            "type": "live_analysis",
            "state": "active",
            "timestamp": "2024-04-01T10:30:00.000Z",
            "duration": 120,
            "config": {
                "removeMedia": true
            },
            "sources": [
                {
                    "id": "c1fcba18-15ec-457c-a1de-fcbb87aeaa0e",
                    "name": "Integrated Webcam",
                    "type": "video",
                    "device": "local_camera"
                },
                {...},
                {...}
            ],
            "meta": {
                "expires": "2024-05-01T11:30:00.000Z",
                "healthCheck": "2024-05-01T10:39:30.000Z",
                "workerState": "working"
            },
            "product": "65946a77408bd7b32c5189a3",
            "user": "65d7a8fb532f66218ecd4cab",
            "version": 3
        },
        {...},
        {...}
    ]
}