List events

GET

https://api.schematichq.com/events

GET

/events

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.events.listEvents();

Try it

1 {
2   "data": [
3     {
4       "body": {
5         "key": "value"
6       },
7       "body_preview": "body_preview",
8       "captured_at": "2024-01-15T09:30:00Z",
9       "feature_ids": [
10         "feature_ids"
11       ],
12       "features": [
13         {
14           "id": "id",
15           "name": "name"
16         }
17       ],
18       "id": "id",
19       "quantity": 1,
20       "status": "status",
21       "type": "type",
22       "updated_at": "2024-01-15T09:30:00Z",
23       "api_key": "api_key",
24       "company": {
25         "id": "id",
26         "name": "name"
27       },
28       "company_id": "company_id",
29       "enriched_at": "2024-01-15T09:30:00Z",
30       "environment_id": "environment_id",
31       "error_message": "error_message",
32       "loaded_at": "2024-01-15T09:30:00Z",
33       "processed_at": "2024-01-15T09:30:00Z",
34       "sent_at": "2024-01-15T09:30:00Z",
35       "subtype": "subtype",
36       "user": {
37         "id": "id",
38         "name": "name"
39       },
40       "user_id": "user_id"
41     }
42   ],
43   "params": {
44     "company_id": "company_id",
45     "event_subtype": "event_subtype",
46     "event_types": [
47       "identify"
48     ],
49     "flag_id": "flag_id",
50     "limit": 1,
51     "offset": 1,
52     "user_id": "user_id"
53   }
54 }

Query parameters

company_idstringOptional

event_subtypestringOptional

event_typesenumOptional

Allowed values:

flag_idstringOptional

user_idstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List events

Headers

Query parameters

Response

Errors