Get monthly consumption data

POST https://api.octopush.com/v1/public/monthly-consumption

Encoding : UTF-8

Authentication

Your "api-key" and "api-login" identifiers must be added in the headers.

Definition

This service allows you to retrieve your monthly consumption data for credit management purposes.

Special parameters

Name	Type	Description
channel	string	This value is the channel type (sms, voice, etc.).
year	int	This value is the year for consumption data.
month	int	This value is the month for consumption data (1-12).
agent_email	string	This value is the agent email address (optional).

Server Response Example in JSON

Success

{
   "year": 2025,
   "month": 7,
   "number_of_sendings": 1969,
   "cost": 83.41,
   "consumption_by_agent": [
       {
           "agent_email": "[email protected]",
           "number_of_sendings": 734,
           "cost": 4.56
       },
       {
           "agent_email": "[email protected]",
           "number_of_sendings": 1235,
           "cost": 78.85
       }
   ]
}