Historique des campagnes

Cette méthode vous permet de récuperer votre consommation.

GET

/metrics/consumption

Paramètres GET

date_start Ajouter un filtre pour récupérer votre consommation dont la date d'envoi se situe après cette date. La date doit avoir le format suivant: Y-m-d
date_end Ajouter un filtre pour récupérer votre consommation dont la date d'envoi se situe avant cette date. La date doit avoir le format suivant: Y-m-d
country Ajouter un filtre pour récupérer votre consommation pour un pays spécifique. Vous pouvez récuperer la consommation de plusieurs pays en les séparant d'une virgule. Les pays doivent être au format alpha2. country=FR,CH
sub_account_id Ajouter un filtre pour récupérer votre consommation pour un sous compte spécifique.

Exemples


GET /metrics/consumption HTTP/1.1
Host: api.smsup.ch
Accept: application/json
Authorization: Bearer your.token

Format de la réponse


{
    "status": 1,
    "message": "OK",
    "data": {
        "total": 100,
        "by_country": {
            "FR": 50,
            "CH": 30,
            "IT": 20,
        },
        "my_account": {
            "account_id": 1,
            "company": "My company",
            "conso": {
                "total": 80,
                "by_country": {
                    "FR": 50,
                    "CH": 30,
                }
            }
        },
        "by_sub_accounts": [
            {
                "account_id": 2,
                "company": "My sub account company",
                "conso": {
                    "total": 20,
                    "by_country": [
                        "IT" : 20
                    ]
                }
            }
        ]
    }
}
          
        

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <status>1</status>
  <message>OK</message>
  <data>
    <total>100</total>
    <by_country>
        <FR>50</FR>
        <CH>30</CH>
        <IT>20</IT>
    </by_country>
    <my_account>
        <account_id>1</account_id>
        <company>My company</company>
        <conso>
            <total>80</total>
            <by_country>
                <FR>50</FR>
                <CH>30</CH>
            </by_country>
        </conso>
    </my_account>
    <by_sub_accounts>
        <account_id>2</account_id>
        <company>My sub account company</company>
        <conso>
            <total>20</total>
            <by_country>
                <IT>20</IT>
            </by_country>
        </conso>
    </by_sub_accounts>
  </data>
</response>