Skip to main content

Core Concepts

Understanding SEDL's core concepts will help you make the most of the platform. SEDL organizes your data in a simple three-tier hierarchy: Apps → Event Types → Events.

The SEDL Hierarchy​

Apps​

An App represents a single application or system that you want to monitor. Apps serve as containers for your event data and provide:

  • Organization: Keep events from different applications separate
  • Collaboration: Share access with team members
  • Authentication: Each app has its own logging token
  • Analytics: App-level dashboards and insights

App Properties​

PropertyDescription
IDUnique identifier for the app
NameHuman-readable name for identification
UsersList of team members with access
Created AtWhen the app was created
Event Logging TokenAuthentication token for API requests

Event Types​

Event Types categorize different kinds of interactions or events within your app. They help organize your data and make analytics more meaningful.

Examples of Event Types​

  • user_registration - When users sign up
  • button_click - UI interaction tracking
  • error_occurred - Error logging
  • payment_completed - Transaction tracking
  • page_view - Navigation monitoring

Event Type Properties​

PropertyDescription
IDUnique identifier for the event type
NameDescriptive name for the event category
App IDWhich app this event type belongs to
Created AtWhen the event type was created

Events​

Events are individual occurrences of a specific event type. Each event represents a single interaction, action, or occurrence in your application.

Event Properties​

PropertyDescription
IDUnique identifier for the event
Event Type IDWhich category this event belongs to
App IDWhich app this event belongs to
Created AtWhen the event occurred
PayloadCustom data associated with the event

The Event Payload​

The payload is the most powerful part of an event. It's a flexible JSON object where you can store any relevant data:

Example: E-commerce Purchase Event
{
  "userId": "user_12345",
  "orderId": "order_67890",
  "totalAmount": 129.99,
  "currency": "USD",
  "items": [
    {
      "productId": "prod_abc",
      "name": "Wireless Headphones",
      "price": 129.99,
      "quantity": 1
    }
  ],
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "country": "US",
    "state": "CA",
    "city": "San Francisco"
  }
}
Payload Best Practices
  • Include relevant identifiers (user ID, session ID, etc.)
  • Add contextual information (page, feature, etc.)
  • Keep data structured and consistent
  • Include timestamps when relevant
  • Don't include sensitive information (passwords, full credit card numbers)

Data Flow Example​

Here's how data flows through SEDL for a typical e-commerce application:

  1. Create App: "My Online Store"
  2. Define Event Types:
    • "product_view"
    • "add_to_cart"
    • "purchase_completed"
  3. Send Events: POST requests with relevant payload data
  4. Analyze: View trends, conversion rates, and user behavior

Authentication & Security​

Each app has a unique Event Logging Token that authenticates your API requests. This token:

  • Is required for all event creation requests
  • Is unique to each app
  • Can be regenerated if compromised
  • Should be kept secure and not exposed in client-side code
Security Note

Never expose your logging token in client-side JavaScript or mobile app code. Always make API calls from your backend servers.

Next Steps​

Now that you understand SEDL's core concepts, you're ready to: