Skip to main content

API Reference

The SEDL Public API provides programmatic access to your event logging and data retrieval capabilities. Our API is designed to be simple, reliable, and easy to integrate into any application.

Base URL

All API requests should be made to:

https://api.sedl.dev

Authentication

SEDL uses two types of authentication tokens depending on the operation:

Event Logging Token

Used for creating events (write operations):

  • Found in your app's dashboard
  • Required for all event creation requests
  • Unique to each app
  • Should be kept secure on your backend servers

Resource Token

Used for reading data (read operations):

  • Used to retrieve existing events and analytics data
  • Read-only access to specific apps
  • Can be shared with analytics tools and team members
Security Best Practice

Never expose authentication tokens in client-side code. Always make API calls from your backend servers to keep tokens secure.

Available Endpoints

Event Management

Data Format

All API requests and responses use JSON format. Make sure to include the appropriate headers:

Content-Type: application/json

Rate Limiting

To ensure service quality for all users, the SEDL API implements rate limiting:

  • Event Creation: 1000 requests per minute per app
  • Data Retrieval: 100 requests per minute per resource token

When rate limits are exceeded, the API will return a 429 Too Many Requests status code.

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Status CodeMeaning
200OK - Request successful
201Created - Event created successfully
400Bad Request - Invalid request data
401Unauthorized - Invalid or missing authentication
403Forbidden - Access denied to resource
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Server-side issue

Error Response Format

When an error occurs, the API returns a JSON response with details:

Error Response Example
{
"success": false,
"error": "Invalid logging token",
"details": "The provided logging token is not valid or has expired",
"code": "AUTH_INVALID_TOKEN"
}

Getting Started

  1. Create an app in the SEDL dashboard
  2. Get your logging token from the app settings
  3. Create event types to categorize your events
  4. Start sending events using the API

Need Help?