Delivery Receipts

This endpoint can be used to retrieve Delivery Receipts (DLR) statistics for a specific chatbot. The data you can retrieve with this API endpoint is identical to the data available in live dashboards.

Bot Statistics calls are throttled at 1 call per bot every 30 minutes. Trying to access this endpoint before the expired hour will result in an error.

Request

The following request will retrieve statistics data:

curl --location --request GET 
'https://publicapi.xenioo.com/analytics/statistics/dlr/<GROUPMODE>/<DAYS>' \
--header 'Authorization: Bearer <BOT_AUTH_TOKEN>' \
--header 'Content-Type: application/json'

Parameters

The following parameters are expected on the endpoint:

Parameter	Description
GROUPMODE	The time group mode for the returned values. Sett below table for possible values
DAYS	The amount of history days to return. Acceptable values go from 1 to 30 days of history.
FROM	The start date for returned values. Template of date is YYYY-MM-dd.
TO	The end date for returned values. Template of date is YYYY-MM-dd.
CHANNELID	The channel for returned values
BROADCASTID	The broadcast for returned values.
INCLUDEPREVIOUSPERIOD	If true, it returns also the data of the same amount of days requested doubled.

Supported types are as follows:

Time grouping modes can be instead one of the following:

Value	Description
hour	Group entries by hours
day	Group entries by days
month	Group entries by months
year	Group entries by years
minute	Group entries every 10 minutes

Response

If successful, the response will contain a detailed array of statistical data.

[
   {
      "GroupLabel":"...",
      "GroupMode":"...",
      "EventLabel":"...",
      "ParentAPIKey":"...",
      "ChannelName":"...",
      "ChannelProviderId":"...",
      "Date":"...",
      "Value":1,
      "Count":1
   } 
]

Response Codes

This endpoint will reply with the following standard HTTP codes.

Code	Meaning
200	Ok. The request has been successfully fulfilled.
404	Not Found. The specified account or bot has not been found.