get-messages-sent.md

Get Messages Sent

Retrieve the number of messages sent daily during a specific period.

{% hint style="info" %} It requires view-engagement-dashboard permission. {% endhint %}

URL	Requires Auth	HTTP Method
/api/v1/engagement-dashboard/messages/messages-sent	yes	GET

Query Parameter

Argument	Example	Required	Description
start	2023-05-20T00:00:00.000Z	Required	The start date.
end	2023-10-05T14:48:00.000Z	Required	The end date.

Example Call

curl --location 'http://localhost:3000/api/v1/engagement-dashboard/messages/messages-sent?start=2023-05-20T00%3A00%3A00.000Z&end=2023-05-30T00%3A00%3A00.000Z' \
--header 'x-auth-token: HF0U3GBQHzC0pL_f_XXFHEfgXR8041XGldg2m_z8JQ0' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ'

Example Result

Success

{
    "days": [
        {
            "day": "2023-05-30T00:00:00.000Z",
            "messages": 183
        },
        {
            "day": "2023-05-29T00:00:00.000Z",
            "messages": 101
        },
        {
            "day": "2023-05-27T00:00:00.000Z",
            "messages": 1
        },
        {
            "day": "2023-05-26T00:00:00.000Z",
            "messages": 114
        },
        {
            "day": "2023-05-25T00:00:00.000Z",
            "messages": 79
        },
        {
            "day": "2023-05-24T00:00:00.000Z",
            "messages": 126
        },
        {
            "day": "2023-05-23T00:00:00.000Z",
            "messages": 129
        },
        {
            "day": "2023-05-22T00:00:00.000Z",
            "messages": 22
        },
        {
            "day": "2023-05-21T00:00:00.000Z",
            "messages": 5
        }
    ],
    "period": {
        "count": 760,
        "variation": 716
    },
    "yesterday": {
        "count": 101,
        "variation": 82
    },
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• No Permission: Occurs when the authenticated user doesn't have the view-engagement-dashboard permission.
• Invalid Date: This occurs when the start or end date does not follow the accepted format ( 2023-10-05T14:48:00.000Z).

{% tabs %} {% tab title="Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="No Permission" %}

{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}

{% endtab %}

{% tab title="Invalid Date" %}

{
    "success": false,
    "error": "Match error: Failed Match.Where validation in field start"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
3.1.0	Added