Monthly organization traffic and cost statistics

GET

https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/stats

GET

/api/v1/organisation/:org_id_or_my/stats

curl https://cdn.emnify.net/api/v1/organisation/my/stats \
     -H "Authorization: Bearer <token>"

{
  "current_month": {
    "data": {
      "cost": 9.713,
      "month": "2022-12-01T00:00:00.000Z",
      "currency": {
        "code": "EUR",
        "symbol": "€",
        "id": 1
      },
      "traffic_type": {
        "description": "Data",
        "unit": "MB",
        "id": 5
      },
      "volume": 80.21357,
      "volume_rx": 50.106785,
      "volume_tx": 30.106785
    },
    "sms": {
      "cost": 0.6,
      "month": "2022-12-01T00:00:00.000Z",
      "currency": {
        "code": "EUR",
        "symbol": "€",
        "id": 1
      },
      "traffic_type": {
        "description": "SMS",
        "unit": "SMS",
        "id": 6
      },
      "volume": 9,
      "volume_rx": 2,
      "volume_tx": 7
    }
  },
  "last_month": {
    "data": {
      "cost": 11.519,
      "month": "2022-11-01T00:00:00.000Z",
      "currency": {
        "code": "USD",
        "symbol": "$",
        "id": 2
      },
      "traffic_type": {
        "description": "Data",
        "unit": "MB",
        "id": 5
      },
      "volume": 100.21357,
      "volume_rx": 50.106785,
      "volume_tx": 50.106785
    },
    "sms": {
      "cost": 0.7,
      "month": "2022-11-01T00:00:00.000Z",
      "currency": {
        "code": "EUR",
        "symbol": "€",
        "id": 1
      },
      "traffic_type": {
        "description": "SMS",
        "unit": "SMS",
        "id": 6
      },
      "volume": 10,
      "volume_rx": 6,
      "volume_tx": 4
    }
  },
  "sim": {
    "issued": 0,
    "active": 498,
    "suspended": 2,
    "total": 500,
    "factory_test": 0
  },
  "service_profiles": 1,
  "tariff_profiles": 2,
  "users": 5,
  "active_chargeable_sims": 10,
  "hosting_fees": 100,
  "inclusive_volume": {
    "unpooled": 60.5,
    "pooled": 14.3
  }
}

Organisation.Stats + Get

Roles: Administrator User Observer

Retrieves traffic and cost statistics for the selected organization.

Traffic statistics accumulate for the current_month and last_month of the selected organization and all child organizations. All other returned values (SIM statistics, user counts, etc.) are only for the selected organization.

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Organisation.Stats` + `Get` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> Retrieves traffic and cost statistics for the selected organization. Traffic statistics accumulate for the `current_month` and `last_month` of the selected organization and all child organizations. All other returned values (SIM statistics, user counts, etc.) are only for the selected organization.

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_mystringRequiredformat: "^(my)|(\d+)$"Defaults to my

Numerical ID of an Organization or the string my to use the currently authorized organisation

Response

current_monthobjectOptional

last_monthobjectOptional

simobjectOptional

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

service_profilesdoubleOptional

Amount of service profiles

tariff_profilesdoubleOptional

Amount of service profiles

usersdoubleOptional

Amount of users

active_chargeable_simsdoubleOptional

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

hosting_feesdoubleOptional

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

inclusive_volumeobjectOptional

prepaid_balanceobjectOptional

Errors

403

Forbidden Error

422

Unprocessable Entity Error