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        "user_id": "user-7890abcd1234efgh",
7        "plan": "premium",
8        "referrer": "google_ads"
9      }
10    },
11    "body_preview": "{\"event\":\"user_signup\",\"details\":{\"user_id\":\"user-7890abcd1234efgh\"}}",
12    "captured_at": "2024-04-20T15:30:00Z",
13    "feature_ids": [
14      "feat-1234abcd5678efgh",
15      "feat-2345bcde6789fghi"
16    ],
17    "features": [
18      {
19        "id": "feat-1234abcd5678efgh",
20        "name": "Signup Tracking",
21        "description": "User signup tracking feature",
22        "image_url": "https://cdn.schematichq.com/features/signup.png"
23      },
24      {
25        "id": "feat-2345bcde6789fghi",
26        "name": "Premium Analytics",
27        "description": "Premium plan analytics",
28        "image_url": "https://cdn.schematichq.com/features/premium_analytics.png"
29      }
30    ],
31    "id": "evt-20240420-0001",
32    "quantity": 1,
33    "status": "pending",
34    "type": "track",
35    "api_key": "a1b2c3d4e5f67890abcdef1234567890",
36    "api_key_view": {
37      "created_at": "2024-01-15T09:30:00Z",
38      "id": "apikey-1234abcd5678efgh",
39      "name": "Stripe Integration Key",
40      "readonly": false,
41      "scopes": [
42        "read",
43        "write"
44      ],
45      "updated_at": "2024-04-15T10:00:00Z",
46      "description": "Primary API key for production environment",
47      "environment": {
48        "created_at": "2023-12-01T08:00:00Z",
49        "environment_type": "production",
50        "id": "env-prod-001",
51        "name": "Production Environment",
52        "updated_at": "2024-01-10T12:00:00Z"
53      },
54      "environment_id": "env-prod-001",
55      "integration": {
56        "id": "intg-9876zyxw4321vuts",
57        "state": "active",
58        "type": "stripe"
59      },
60      "last_used_at": "2024-04-20T15:45:00Z"
61    },
62    "company": {
63      "id": "comp-4567defg8901hijk",
64      "name": "Cloud Analytics Inc.",
65      "description": "Leading provider of cloud-based analytics",
66      "image_url": "https://cdn.schematichq.com/logos/company4567.png"
67    },
68    "company_id": "comp-4567defg8901hijk",
69    "environment_id": "env-prod-001",
70    "error_message": null,
71    "idempotency_key": "idem-20240420-xyz123",
72    "lease_id": "lease-7890abcd",
73    "loaded_at": "2024-04-20T15:31:00Z",
74    "sent_at": "2024-04-20T15:32:00Z",
75    "subtype": "user_event",
76    "user": {
77      "id": "user-7890abcd1234efgh",
78      "name": "Jane Doe",
79      "description": "End user who signed up",
80      "image_url": "https://cdn.schematichq.com/users/user7890.png"
81    },
82    "user_id": "user-7890abcd1234efgh",
83    "enriched_at": null,
84    "processed_at": null,
85    "updated_at": null
86  },
87  "params": {}
88}
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