API Documentation
Integrate Error Explorer into your applications
Complete REST API to send, retrieve and manage your errors programmatically.
API Example
# Send error to Error Explorer
curl -X POST https://api.error-explorer.com/webhook
-H "Authorization: Bearer YOUR_API_KEY"
-H "Content-Type: application/json"
-d '{"message": "Error occurred"}'
# Ready to track errors!
API Introduction
The Error Explorer API allows you to programmatically access your error data, manage your projects and get detailed statistics to integrate error monitoring into your existing workflows.
Response Format
All responses are in JSON format with appropriate HTTP status codes.
response.json
{
"success" : true ,
"data" : { ... },
"timestamp" : "2025-09-29T14:30:25+00:00"
}
Authentication
All API requests require authentication via an API key. Your API key must be included in the Authorization header of each request.
Registration Required
Create a free account to generate an API key and access all features.
Create an accountUsing the API Key
Include your API key in the header of all your requests:
headers
Authorization: Bearer YOUR_API_KEY
headers
X-API-Key: YOUR_API_KEY
Rate Limiting
The Error Explorer API applies rate limits to ensure service stability.
Current Limits
Free Plan: 1000 requests/hour
Limit Headers
Each response includes headers indicating your current usage:
headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1693574400
Project Management
Manage your Error Explorer projects.
Retrieves the list of your projects.
Query Parameters
page
integer
optional
Page number (default: 1)
limit
integer
optional
Number of results per page (default: 20, max: 100)
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/projects?page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"
Response (200 OK)
response.json
{
"success" : true ,
"data" : [
{
"id" : 1 ,
"name" : "My Application" ,
"environment" : "production" ,
"error_count" : 142 ,
"created_at" : "2025-01-15T10:30:00Z"
}
],
"pagination" : {
"page" : 1 ,
"limit" : 20 ,
"total" : 3
}
}
Creates a new project
Request Body
name
string
required
Project name (max 255 characters)
description
string
optional
Project description
environment
string
required
Environment (prod, staging, dev, test)
notification_email
string
optional
Email for notifications
Example Request
curl
curl -X POST "https://error-explorer.com/api/v2/projects" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "My Web Application",
"description": "Management application",
"environment": "prod",
"notification_email": "admin@example.com"
}'
Updates an existing project
URL Parameters
id
integer
required
ID of the project to update
Request Body
name
string
optional
New project name
description
string
optional
New project description
environment
string
optional
Environment (dev, staging, prod)
Example Request
curl
curl -X PUT "https://error-explorer.com/api/v2/projects/1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "My Updated Application",
"description": "Updated description"
}'
Response (200 OK)
response.json
{
"success" : true ,
"message" : "Project updated successfully" ,
"data" : {
"id" : 1 ,
"name" : "My Updated Application" ,
"updated_at" : "2025-01-15T11:30:00Z"
}
}
Permanently deletes a project and all its data
URL Parameters
id
integer
required
ID of the project to delete
Required Headers
X-Confirm-Delete
string
required
Must be "true" to confirm deletion
Example Request
curl
curl -X DELETE "https://error-explorer.com/api/v2/projects/1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-Confirm-Delete: true"
Response (200 OK)
response.json
{
"success" : true ,
"message" : "Project deleted successfully"
}
⚠️ Warning
Project deletion is irreversible. All errors, statistics and associated data will be permanently deleted.
Error Management
Endpoints to retrieve, update and manage errors from your projects.
Retrieve the list of errors for a project
URL Parameters
id
integer
required
Project ID
Query Parameters
page
integer
optional
Page number (default: 1)
limit
integer
optional
Number of results per page (default: 20, max: 100)
status
string
optional
Filter by status: new, resolved, ignored
severity
string
optional
Filter by severity: low, medium, high, critical
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/projects/1/errors?status=new&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Response (200 OK)
response.json
{
"success" : true ,
"data" : [
{
"id" : 123 ,
"message" : "Database connection failed" ,
"status" : "new" ,
"severity" : "high" ,
"occurrences" : 42 ,
"first_seen" : "2025-01-15T10:30:00Z" ,
"last_seen" : "2025-01-15T12:15:00Z"
}
],
"pagination" : {
"page" : 1 ,
"limit" : 10 ,
"total" : 142
}
}
Retrieve complete details of a specific error
URL Parameters
id
integer
required
Error ID
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/errors/123" \
-H "Authorization: Bearer YOUR_API_KEY"
Update the status or properties of an error
URL Parameters
id
integer
required
ID of the error to update
Request Body
status
string
optional
New status: new, resolved, ignored
assignee_id
integer
optional
ID of the assigned user
tags
array
optional
List of tags to assign
Example Request
curl
curl -X PATCH "https://error-explorer.com/api/v2/errors/123" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "resolved",
"tags": ["bug", "database"]
}'
Analytics & Statistics
Retrieve detailed statistics and metrics about your errors to analyze trends and improve the quality of your applications.
Retrieve basic statistics for all your projects
Query Parameters
period
string
optional
Period: 7d, 30d, 90d (default: 7d)
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/analytics/basic?period=30d" \
-H "Authorization: Bearer YOUR_API_KEY"
Response (200 OK)
response.json
{
"success" : true ,
"data" : {
"total_errors" : 2547 ,
"affected_users" : 342 ,
"error_rate" : "0.23%" ,
"trend" : "-15%" ,
"top_errors" : [
{
"message" : "Database connection failed" ,
"count" : 523 ,
"impact" : "high"
}
]
}
}
Retrieve detailed statistics for a specific project
URL Parameters
id
integer
requis
ID du projet
Query Parameters
period
string
optional
Period: 24h, 7d, 30d, 90d (default: 7d)
group_by
string
optional
Group by: hour, day, week (default: day)
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/projects/1/analytics?period=7d&group_by=day" \
-H "Authorization: Bearer YOUR_API_KEY"
Webhooks
Webhooks allow your applications to automatically send errors to Error Explorer as soon as they occur.
Main endpoint to receive errors from your applications
URL Parameters
token
string
required
Unique token for your project
Request Body
message
string
required
Error message
level
string
optional
Level: error, warning, info (default: error)
exception
object
optional
Exception details (type, stacktrace)
context
object
optional
Error context (user, request, server)
breadcrumbs
array
optional
History of actions before the error
Example Request
curl
curl -X POST "https://error-explorer.com/webhook/error/YOUR_PROJECT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"message": "Database connection failed",
"level": "error",
"exception": {
"type": "PDOException",
"stacktrace": "..."
},
"context": {
"user": {"id": 123, "email": "user@example.com"},
"request": {"url": "/api/users", "method": "GET"}
}
}'
Response (200 OK)
response.json
{
"success" : true ,
"error_id" : "err_abc123xyz" ,
"fingerprint" : "d4f6g8h9"
}
Verify connectivity and validity of your token
URL Parameters
token
string
required
Unique token for your project
Example Request
curl
curl -X GET "https://error-explorer.com/webhook/ping/YOUR_PROJECT_TOKEN"
Response (200 OK)
response.json
{
"success" : true ,
"message" : "Webhook endpoint is active" ,
"project" : "Mon Application"
}
System Status
Check the health and availability of Error Explorer services in real time.
Retrieve the complete system status
ℹ️ Note
This endpoint does not require authentication and can be used for external monitoring.
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/system-status"
Response (200 OK)
response.json
{
"status" : "operational" ,
"timestamp" : "2025-01-15T14:30:00Z" ,
"services" : {
"api" : "operational" ,
"database" : "operational" ,
"cache" : "operational" ,
"queue" : "operational"
},
"metrics" : {
"response_time_ms" : 45 ,
"uptime_percentage" : 99.98
}
}
Simplified version for frequent polling
Example Request
curl
curl -X GET "https://error-explorer.com/api/v2/system-status/basic"
Response (200 OK)
response.json
{
"status" : "operational" ,
"timestamp" : "2025-01-15T14:30:00Z"
}
Error Codes
The API uses standard HTTP status codes and returns detailed error messages in JSON.
Error Format
error.json
{
"success" : false ,
"error" : {
"code" : "INVALID_PARAMETERS" ,
"message" : "Project name is required" ,
"details" : {
"field" : "name"
}
}
}