Insights Object

The Insights object represents the message statistics returned by the Insights APIs. The statistics include both single messages and batch messages.

Attributes

submitted

integer

Number of submitted messages.

processed

integer

Number of processed messages.

rejected

integer

Number of rejected messages.

sent

integer

Number of sent messages.

delivered

integer

Number of delivered messages.

failed

integer

Number of failed messages.

inProgress

integer

Number of in progress messages.

intervals

array

Contains an hourly, daily, weekly, or monthly breakdown of the message statistics.

Note The intervals array is not returned for the Batch Insights API.

dateTime

string (date-time)

Date and time of the interval.

submitted

integer

Number of submitted messages.

processed

integer

Number of processed messages.

rejected

integer

Number of rejected messages.

sent

integer

Number of sent messages.

delivered

integer

Number of delivered messages.

failed

integer

Number of failed messages.

Insights Object

				
					{
  "result": {
    "submitted": 100,
    "processed": 100,
    "rejected": 0,
    "sent": 100,
    "delivered": 100,
    "failed": 0,
    "inProgress": 0,
    "intervals": [
      {
        "dateTime": "2023-04-16T23:37:13.653Z",
        "submitted": 20,
        "processed": 20,
        "rejected": 0,
        "sent": 20,
        "delivered": 20,
        "failed": 0
      },
      {...},
      {...}
    ]
  }
}