v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

View Volume and Price Analytics for a specific bulk send out - campaign

Returns analytics for a range of messages specified by a time frame associated with the owner account and a belonging campaign ID.

get/reports/my/volPrice/perCampaign

Query parameters

offsetstring date-time required

The time offset that the result will be calculated in ISO 8601.

campaignIdstring required

The id of the campaign that the messages belong to.

Headers

Authorizationstring

Response

200

startDateTimestring
timeGroupingstring
deliveredCountinteger
undeliveredCountinteger
failedCountinteger
queuedCountinteger
sentCountinteger
unsentCountinteger
countinteger
pricenumber
countrystring
operatorstring
mccstring
mncstring
smsCampaignIdstring

Example response

[
  {
    "startDateTime": "2023-01-02T09:00:00Z",
    "timeGrouping": "Hours",
    "deliveredCount": 1,
    "count": 1,
    "price": 0.161,
    "country": "BY",
    "operator": "MTS",
    "mcc": "257",
    "mnc": "02",
    "smsCampaignId": "a549a05a-84c5-4c4c-9136-969bf1bff9e4"
  }
]