Monthly organization traffic and cost statistics

1 import requests 2 3 url = "https://cdn.emnify.net/api/v1/organisation/org_id_or_my/stats" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "current_month": { 3 "data": { 4 "cost": 9.713, 5 "month": "2022-12-01T00:00:00.000Z", 6 "currency": { 7 "code": "EUR", 8 "symbol": "€", 9 "id": 1 10 }, 11 "traffic_type": { 12 "description": "Data", 13 "unit": "MB", 14 "id": 5 15 }, 16 "volume": 80.21357, 17 "volume_rx": 50.106785, 18 "volume_tx": 30.106785 19 }, 20 "sms": { 21 "cost": 0.6, 22 "month": "2022-12-01T00:00:00.000Z", 23 "currency": { 24 "code": "EUR", 25 "symbol": "€", 26 "id": 1 27 }, 28 "traffic_type": { 29 "description": "SMS", 30 "unit": "SMS", 31 "id": 6 32 }, 33 "volume": 9, 34 "volume_rx": 2, 35 "volume_tx": 7 36 } 37 }, 38 "last_month": { 39 "data": { 40 "cost": 11.519, 41 "month": "2022-11-01T00:00:00.000Z", 42 "currency": { 43 "code": "USD", 44 "symbol": "$", 45 "id": 2 46 }, 47 "traffic_type": { 48 "description": "Data", 49 "unit": "MB", 50 "id": 5 51 }, 52 "volume": 100.21357, 53 "volume_rx": 50.106785, 54 "volume_tx": 50.106785 55 }, 56 "sms": { 57 "cost": 0.7, 58 "month": "2022-11-01T00:00:00.000Z", 59 "currency": { 60 "code": "EUR", 61 "symbol": "€", 62 "id": 1 63 }, 64 "traffic_type": { 65 "description": "SMS", 66 "unit": "SMS", 67 "id": 6 68 }, 69 "volume": 10, 70 "volume_rx": 6, 71 "volume_tx": 4 72 } 73 }, 74 "sim": { 75 "issued": 0, 76 "active": 498, 77 "suspended": 2, 78 "total": 500, 79 "factory_test": 0 80 }, 81 "service_profiles": 1, 82 "tariff_profiles": 2, 83 "users": 5, 84 "active_chargeable_sims": 10, 85 "hosting_fees": 100, 86 "inclusive_volume": { 87 "unpooled": 60.5, 88 "pooled": 14.3 89 } 90 }

Retrieves traffic and cost statistics for the selected organisation.

Traffic statistics accumulate for the current_month and last_month of the selected organisation and all its child organisations. All other returned values (i.e., SIM statistics, user counts, etc.) are only for the selected organisation.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

org_id_or_mystringRequired

Response

current_monthobject or null

last_monthobject or null

simobject or null

Amount of SIMs per SIM status where the selected organisation is either the customer organisation or the issuer organisation

service_profilesdouble or null

Amount of service profiles

tariff_profilesdouble or null

Amount of service profiles

usersdouble or null

Amount of users

active_chargeable_simsdouble or null

Amount of active SIMs that will be charged within the current month. This field is omitted if there are no chargeable SIMs.

hosting_feesdouble or null

Total of SIM hosting fees for all active_chargeable_sims. This field is omitted if there are no chargeable SIMs.

inclusive_volumeobject or null

prepaid_balanceobject or null

Authentication

Path parameters

Response

Errors