Skip to main content

Getting Started with SEDL

Get up and running with SEDL in just a few minutes. This guide will walk you through creating your first app, setting up event types, and sending your first event.

What You'll Learn
  • How to create and configure your first app
  • How to set up event types for categorizing your data
  • How to send events using the API
  • How to view your data in the dashboard

Step 1: Create Your First App​

After signing in to SEDL, you'll see the "My Apps" screen with a list of apps you own or have access to.

  1. Click the plus-sign button next to the screen title
  2. Enter a descriptive name for your app (e.g., "My Website Analytics")
  3. Click Create

Create app button

Create app screen

Your new app will appear in the list with your role, creation timestamp, and an arrow button to access it.

App list

Step 2: Get Your App Configuration​

Click the arrow button on your app to access the dashboard.

Get Your Logging Token​

  1. Click on "Event Logging Token" in the app dashboard
  2. Copy the token - you'll need this for API requests
Keep Your Token Secure

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

Step 3: Create Event Types​

Event types categorize different kinds of events in your application.

  1. Click "View Events" from your app dashboard
  2. Click the plus-sign button to create a new event type
  3. Enter a descriptive name (e.g., "button_click", "page_view", "user_signup")
  4. Click Create

Create event type button

Create event type screen

Copy the Event Type ID from the list - you'll need this for your API requests.

Step 4: Send Your First Event​

Now you're ready to send events to SEDL! Use the API endpoint with your logging token and event type ID.

API Endpoint​

POST https://api.sedl.dev/public/create_event

Request Structure​

Request Body
{
  "loggingToken": "<your app's logging token>",
  "typeId": "<your event type's ID>",
  "payload": "<any JSON object with your event data>"
}
About the Payload

The payload can be any valid JSON object. This gives you complete flexibility in what information you want to track.

Step 5: Example Implementation​

Request Details​

The request structure is straightforward. You need to provide three main fields:

  • loggingToken: Your app's authentication token
  • typeId: The specific event type identifier
  • payload: Any JSON object with your event data

Response Information​

Success Response

A successful request will return a 201 Created status with the event details including a unique event ID and timestamp.

Error Handling​

Make sure to handle potential errors:

  • 400 - Invalid request body
  • 401 - Invalid logging token
  • 404 - Event type not found

Additional Examples​

You can also use other programming languages like Python or JavaScript. The principle remains the same - make a POST request to the endpoint with the required JSON payload.

cURL Command Example
curl -X POST https://api.sedl.dev/public/create_event \
  -H "Content-Type: application/json" \
  -d '{
    "loggingToken": "f565c835ef40673f1a67f15d294f3e9d",
    "typeId": "038c6337-d021-4767-89f9-1e59e49fe475",
    "payload": {
      "field1": "value1",
      "field2": "value2",
      "timestamp": "2023-10-24T10:30:00Z",
      "userId": "12345",
      "action": "button_click"
    }
  }'
Expected Response
{
  "success": true,
  "eventId": "evt_abc123def456",
  "message": "Event logged successfully",
  "timestamp": "2023-10-24T10:30:05Z"
}
Python Alternative
import requests

response = requests.post(
    "https://api.sedl.dev/public/create_event",
    json={
        "loggingToken": "f565c835ef40673f1a67f15d294f3e9d",
        "typeId": "038c6337-d021-4767-89f9-1e59e49fe475",
        "payload": {"field1": "value1", "field2": "value2"}
    }
)
print(response.json())

Step 6: Manage Your Apps​

Once you have events flowing into SEDL, you can use the management features:

Adding Team Members​

To share your app with other users:

  1. Go to your app dashboard
  2. Click "Add Maintainers"
  3. Enter their email address
  4. Click Submit

Team members will then have access to view and manage events for your app.

Viewing Analytics​

Monitor your events over time:

  1. Click "View Event Dashboard" from your app dashboard
  2. Switch between histogram and accumulated views
  3. Use "Change Time Range" to filter specific periods

Event dashboard

What's Next?​

Congratulations! You've successfully:

  • ✅ Created your first app
  • ✅ Set up event types
  • ✅ Sent your first event
  • ✅ Learned about app management

Continue Learning​

Need Help?​

If you run into any issues:

  • Check the API documentation for detailed endpoint information
  • Review the Core Concepts to better understand SEDL's data model
  • Make sure your JSON payload is valid and properly formatted