Get Number of Sent Messages

Prev Next
Get
/api/v1/engagement-dashboard/messages/messages-sent
Premium tag

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

Permission required: view-engagement-dashboard

Changelog

Version Description
3.1.0 Added
Header parameters
X-Auth-Token
stringRequired

The token of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The user ID of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
stringRequired

The start date.

Example2023-10-29T14:48:00.000Z
end
stringRequired

The end date.

Example2023-11-05T14:48:00.000Z
Responses
200

OK

Success Example
{
  "days": [
    {
      "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
}
Expand All
object
days
Array of object
object
day
string
messages
integer
period
object
count
integer
variation
integer
yesterday
object
count
integer
variation
integer
success
boolean
400

Bad Request

Missing key
{
  "success": false,
  "error": "Match error: Missing key 'start'"
}
Example 2
{
  "success": false,
  "error": "Match error: Failed Match.Where validation in field start"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

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