For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
  • Billing Credits
    • GETList credits
    • POSTCreate credit
    • GETGet credit
    • PUTUpdate credit
    • DELDelete credit
    • GETList credit bundles
    • POSTCreate credit bundle
    • GETGet credit bundle
    • PUTUpdate credit bundle
    • DELDelete credit bundle
    • POSTGrant credits to company
    • GETList company credit grants
    • GETList credit grants
    • PUTZero out credit grant
    • GETList plan credit grants
    • POSTCreate plan credit grant
    • DELDelete plan credit grant
    • GETGet credit ledger
  • Account Members
    • GETList account members
    • GETGet account member
LogoLogo
SupportDashboard
Events

Get event

GET
https://api.schematichq.com/events/:event_id
GET
/events/:event_id
1import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3async function main() {
4    const client = new SchematicClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.events.getEvent("event_id");
8}
9main();
1{
2  "data": {
3    "body": {
4      "event": "user_signup",
5      "details": {
6        "plan": "premium",
7        "referrer": "google_ads"
8      }
9    },
10    "body_preview": "{\"event\":\"user_signup\",\"details\":{\"plan\":\"premium\"}}",
11    "captured_at": "2024-04-10T14:20:00Z",
12    "feature_ids": [
13      "feat_001",
14      "feat_002"
15    ],
16    "features": [
17      {
18        "id": "feat_001",
19        "name": "Signup Tracking",
20        "description": "User signup tracking feature",
21        "image_url": "https://example.com/images/feature_signup.png"
22      }
23    ],
24    "id": "evt_9876543210abcdef",
25    "quantity": 1,
26    "status": "enriched",
27    "type": "flag_check",
28    "api_key": "a1b2c3d4e5f6g7h8i9j0",
29    "api_key_view": {
30      "created_at": "2024-01-15T09:30:00Z",
31      "id": "key_0987654321fedcba",
32      "name": "Dev API Key",
33      "readonly": true,
34      "scopes": [
35        "admin"
36      ],
37      "updated_at": "2024-04-10T14:22:00Z",
38      "description": "Primary API key for production environment",
39      "environment": {
40        "created_at": "2024-01-15T09:30:00Z",
41        "environment_type": "development",
42        "id": "env_1234567890abcdef",
43        "name": "Development Environment",
44        "updated_at": "2024-01-15T09:30:00Z"
45      },
46      "environment_id": "env_1234567890abcdef",
47      "integration": {
48        "id": "int_abcdef1234567890",
49        "state": "active",
50        "type": "clerk"
51      },
52      "last_used_at": "2024-04-10T14:22:00Z"
53    },
54    "company": {
55      "id": "comp_1234abcd5678efgh",
56      "name": "CloudTech Inc.",
57      "description": "Leading provider of cloud solutions",
58      "image_url": "https://example.com/images/company_logo.png"
59    },
60    "company_id": "comp_1234abcd5678efgh",
61    "environment_id": "env_1234567890abcdef",
62    "error_message": null,
63    "idempotency_key": "idem_1234567890abcdef",
64    "loaded_at": "2024-04-10T14:21:00Z",
65    "sent_at": "2024-04-10T14:20:30Z",
66    "subtype": "user_event",
67    "user": {
68      "id": "user_1234567890abcdef",
69      "name": "Jane Doe",
70      "description": "Registered user from marketing campaign",
71      "image_url": "https://example.com/images/users/user123.png"
72    },
73    "user_id": "user_1234567890abcdef",
74    "enriched_at": "2024-04-10T14:25:00Z",
75    "processed_at": "2024-04-10T14:23:00Z",
76    "updated_at": "2024-04-10T14:23:00Z"
77  },
78  "params": {}
79}
Was this page helpful?
Previous

The Feature object

Next
Built with

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Path parameters

event_idstringRequired

event_id

Response

OK
dataobject
paramsobject
Input parameters

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error