ETERA API Documentation

const url = 'https://api.etera.dev/notification/tracking/push?userId=user_987654321&status=delivered&startDate=2024-05-01T00%3A00%3A00Z&endDate=2024-05-15T23%3A59%3A59Z&limit=25&offset=0&sortBy=sent_at&sortOrder=desc';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "success": true,
  "data": [
    {
      "id": "notif_123e4567-e89b-12d3-a456-426614174000",
      "userId": "user_987654321",
      "messageId": "msg_abc123def456",
      "deviceToken": "dTk_1a2b3c4d5e6f7g8h9i0j",
      "topic": null,
      "title": "Welcome to Etera!",
      "body": "Thank you for joining Etera. Get started by exploring your dashboard.",
      "status": "delivered",
      "platform": "ios",
      "notificationType": "direct",
      "data": {
        "screen": "dashboard",
        "promoCode": "WELCOME10"
      },
      "imageUrl": "https://cdn.etera.dev/images/welcome-banner.png",
      "actionUrl": "https://app.etera.dev/dashboard",
      "priority": "high",
      "ttl": 3600,
      "collapseKey": "welcome_notifications",
      "errorMessage": null,
      "retryCount": 0,
      "maxRetries": 3,
      "scheduledFor": null,
      "sentAt": "2024-05-10T14:22:30Z",
      "deliveredAt": "2024-05-10T14:22:45Z",
      "openedAt": "2024-05-10T14:25:00Z",
      "clickedAt": "2024-05-10T14:25:10Z",
      "failedAt": null,
      "createdAt": "2024-05-10T14:20:00Z",
      "updatedAt": "2024-05-10T14:25:10Z"
    }
  ],
  "error": null
}

Get push 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:

Push notification delivery tracking
User notification history
Analytics and reporting
Debugging push notification issues

Get push 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:** - Push notification delivery tracking - User notification history - Analytics and reporting - Debugging push notification issues

Authentication

AuthorizationBearer

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

Query parameters

userIdstringOptional

status"pending" or "sent" or "delivered" or "opened" or "failed" or "invalid_token"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

errorobject