Skip to main content
GET
Get the consumption breakdown over a date range

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

API key for authentication

Query Parameters

From
string<date-time>
required

Start of the consumption range (inclusive)

To
string<date-time>
required

End of the consumption range (inclusive)

Response

Success

Credit consumption broken down by channel, month and agent over a date range

periodFrom
string<date-time>

Start of the range the figures below cover (echoes the requested 'from')

periodTo
string<date-time>

End of the range the figures below cover (echoes the requested 'to')

totalCredits
number<double>

Total credits consumed over the requested range. Each axis below sums to this value.

byChannel
object[] | null

Consumption split by channel over the whole range

byMonth
object[] | null

Consumption split by calendar month

byAgent
object[] | null

Consumption split by agent, each with its own campaign breakdown