Get queue statistics

GET

/push/async/stats

GET

/notification/push/async/stats

const url = 'https://api.etera.dev/notification/push/async/stats';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

200Retrieved

{
  "success": true,
  "data": {
    "queue": {
      "total": 1.1,
      "pending": 1.1,
      "processing": 1.1,
      "completed": 1.1,
      "failed": 1.1,
      "retrying": 1.1,
      "expired": 1.1,
      "cancelled": 1.1
    },
    "processor": {
      "isRunning": true,
      "isProcessing": true,
      "activeJobs": 1.1,
      "maxConcurrency": 1.1
    },
    "health": {
      "queueHealthy": true,
      "processorHealthy": true,
      "overallHealthy": true
    }
  },
  "error": {
    "message": "string",
    "code": "string"
  }
}

Queue Statistics

Retrieves comprehensive statistics about the notification queue system.

Metrics:

Queue status counts (pending, processing, completed, etc.)
Processor status (running, active jobs, concurrency)
Health indicators (queue health, processor health)

Use Cases:

Monitoring queue performance
Health checks
Capacity planning
Troubleshooting

Example Response:

{
  "success": true,
  "data": {
    "queue": {
      "total": 150,
      "pending": 25,
      "processing": 3,
      "completed": 120,
      "failed": 2,
      "retrying": 0,
      "expired": 0,
      "cancelled": 0
    },
    "processor": {
      "isRunning": true,
      "isProcessing": true,
      "activeJobs": 3,
      "maxConcurrency": 10
    },
    "health": {
      "queueHealthy": true,
      "processorHealthy": true,
      "overallHealthy": true
    }
  }
}

Authentication

AuthorizationBearer

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

Response

This endpoint returns an object.

successboolean

dataobjectOptional

errorobjectOptional