ETERA API Documentation

curl https://api.etera.dev/notification/tracking/email \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "success": true,
  "data": [
    {
      "id": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f",
      "userId": "user_123456",
      "messageId": "msg_78910",
      "toEmail": "jane.doe@example.com",
      "subject": "Your Order Confirmation",
      "status": "pending",
      "templateId": "tpl_456789",
      "templateData": {
        "orderNumber": "12345",
        "customerName": "Jane Doe",
        "deliveryDate": "2024-07-10"
      },
      "htmlContent": "<html><body><h1>Thank you for your order, Jane Doe!</h1></body></html>",
      "textContent": "Thank you for your order, Jane Doe!",
      "fromEmail": "sales@shop.example.com",
      "replyTo": "support@shop.example.com",
      "ccEmails": [
        "manager@shop.example.com"
      ],
      "bccEmails": [
        "audit@shop.example.com"
      ],
      "priority": "high",
      "tags": [
        "order",
        "confirmation"
      ],
      "metadata": {
        "campaign": "summer_sale",
        "source": "website"
      },
      "errorMessage": null,
      "retryCount": 0,
      "maxRetries": 3,
      "scheduledFor": null,
      "sentAt": null,
      "deliveredAt": null,
      "openedAt": null,
      "clickedAt": null,
      "failedAt": null,
      "createdAt": "2024-06-20T15:45:00Z",
      "updatedAt": "2024-06-20T15:45:00Z"
    }
  ],
  "error": {
    "message": null,
    "code": null
  }
}

Get email notification tracking records with filtering and pagination.

Query Parameters:

userId: Filter by user ID (optional, defaults to authenticated user)
status: Filter by notification status
startDate: Filter notifications created after this date
endDate: Filter notifications created before this date
limit: Number of records to return (1-100, default: 50)
offset: Number of records to skip (default: 0)
sortBy: Sort field (created_at, sent_at, status)
sortOrder: Sort direction (asc, desc)

Use Cases:

Email delivery tracking
User notification history
Analytics and reporting
Debugging email issues

Get email notification tracking records with filtering and pagination. **Query Parameters:** - **userId**: Filter by user ID (optional, defaults to authenticated user) - **status**: Filter by notification status - **startDate**: Filter notifications created after this date - **endDate**: Filter notifications created before this date - **limit**: Number of records to return (1-100, default: 50) - **offset**: Number of records to skip (default: 0) - **sortBy**: Sort field (created_at, sent_at, status) - **sortOrder**: Sort direction (asc, desc) **Use Cases:** - Email delivery tracking - User notification history - Analytics and reporting - Debugging email issues

Authentication

AuthorizationBearer

JWT token for authentication. Use ‘test-jwt-token’ for development.

Query parameters

userIdstringOptional

status"pending" or "sent" or "delivered" or "failed" or "bounced" or "complained"Optional

startDatedatetimeOptional

endDatedatetimeOptional

limitdoubleOptional1-100

offsetdoubleOptional>=0

sortBy"created_at" or "sent_at" or "status"Optional

sortOrder"asc" or "desc"Optional

Response

This endpoint returns an object.

successboolean

datalist of objects or null

errorobject or null