Get Alerts

Getting alerts

(NOTE: this does not contain alerts content as we do not store alerts content due to compliance reasons)

GET https://api.usealerta.com/v1/alerts

This endpoint help you get alerts based on status, from date,to date, type, page number or , pageSize

Request Query

e.g https://api.usealerta.com/v1/alerts?from=2024-06-20&to=2024-07-23

Name	Type	Description
status	string	the status e.g 'success'
from	date	from date e.g yyyy-mm-dd
to	date	to date e.g yyyy-mm-dd
type	string	the type of alerts, either 'message' or 'reply'
page	number	the page number
pageSize	number	number of items per page

200 Message sent successfully

{
    "statusCode": 200,
    "message": "Alerts retrieved successfully",
    "data": {
        "data": [
            {
                "id": 4,
                "channelSentTo": "channel_name",
                "type": "reply",
                "reference": "ref",
                "status": "success",
                "createAt": "2024-07-18T14:30:03.688Z",
                "updatedAt": "2024-07-18T14:30:03.688Z"
            },
            {
                "id": 5,
                "channelSentTo": "channel_name",
                "type": "message",
                "reference": "ref",
                "status": "success",
                "createAt": "2024-07-16T15:48:34.040Z",
                "updatedAt": "2024-07-16T15:48:34.040Z"
            },
    
        ],
        "total": 2,
        "page": 1,
        "pageSize": 10,
        "prevPage": false,
        "nextPage": false,
        "totalPages": 1
    }
}

403 Forbidden request

{
    "statusCode": 403,
    "message": "Invalid API key",
    "error": "Forbidden"
}