GET
/
api
/
v1
/
events
import os
import syllable_sdk
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.events.list(page=0, search_fields=[
        syllable_sdk.EventProperties.USER_ID,
    ], search_field_values=[
        "Some Object Name",
    ], start_datetime="2023-01-01T00:00:00Z", end_datetime="2024-01-01T00:00:00Z")

    # Handle response
    print(res)
{
  "items": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "session_id": "<string>",
      "conversation_id": "<string>",
      "source": "tool-call",
      "source_id": "<string>",
      "category": "automation",
      "type": "phone-transfer",
      "user_id": "+18042221111",
      "description": "Transfer to phone number +18042221111",
      "attributes": {}
    }
  ],
  "page": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0

The page number from which to start (0-based)

Required range: x >= 0
Example:

0

​
limit
integer
default:25

The maximum number of items to return

Required range: x >= 0
Example:

25

​
search_fields
enum<string>[]

String names of fields to search. Correspond by index to search field values

Available options:
timestamp,
session_id,
conversation_id,
source,
source_id,
category,
type,
user_id,
description,
attributes
Example:

"name"

​
search_field_values
string[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Example:

"Some Object Name"

​
order_by
enum<string> | null

The field whose value should be used to order the results

Available options:
timestamp,
session_id,
conversation_id,
source,
source_id,
category,
type,
user_id,
description,
attributes
Example:

"name"

​
order_by_direction
enum<string> | null

The direction in which to order the results

Available options:
asc,
desc
​
fields
enum<string>[] | null

The fields to include in the response

Available options:
timestamp,
session_id,
conversation_id,
source,
source_id,
category,
type,
user_id,
description,
attributes
​
start_datetime
string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

​
end_datetime
string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

200
application/json
Successful Response
​
items
object[]
required

List of items returned from the query

An event represents a specific occurrence during a session.

​
page
integer
required

The page number of the results (0-based)

Example:

0

​
page_size
integer
required

The number of items returned per page

Example:

25

​
total_pages
integer | null

The total number of pages of results given the indicated page size

Example:

4

​
total_count
integer | null

The total number of items returned from the query

Example:

100