ServicesPlatformEventsEvent types

Data quota management

API reference

Quota information is in the event’s detail object.

Quota threshold reached

Remaining data quota volume fell below the configured threshold percentage. Exclusively for devices with enabled data quota management and a configured quota threshold percentage.

The threshold percentage can be submitted when the data quota is assigned to the device.

Example: if the device’s data quota volume is set to 100 MB and the threshold percentage to 15%, the system generates an event when the remaining volume falls below 15 MB.

1{
2    "timestamp": "2021-10-27T09:06:50.000Z",
3    "alert": true,
4    "description": "Endpoint quota threshold reached, volume is below 80%.",
5    "id": 17357540123,
6    "event_type": {
7        "id": 18,
8        "description": "Quota threshold reached"
9    },
10    "event_source": {
11        "id": 1,
12        "description": "Policy Control"
13    },
14    "event_severity": {
15        "id": 1,
16        "description": "Warn"
17    },
18    "organisation": {
19        "id": 6713,
20        "name": "Test Org"
21    },
22    "endpoint": {
23        "id": 86473615,
24        "imei": "250642987889789",
25        "ip_address": "202.37.156.180",
26        "name": "Factory Test Sim 2",
27        "tags": null
28    },
29    "sim": {
30        "iccid": "56816736458812006983",
31        "id": 1467960,
32        "production_date": "2020-12-23T13:02:11.000Z"
33    },
34    "imsi": {
35        "id": 20616184,
36        "import_date": "2020-12-23T13:02:11.000Z",
37        "imsi": "58834171155367"
38    },
39    "detail": {
40        "quota": {
41            "threshold_percentage": 80,
42            "threshold_volume": 0.8,
43            "volume": -0.00120000000000009
44        }
45    }
46}

Quota used up

Data quota volume is completely depleted. Exclusively for devices with data quota management enabled.

Once this happens, the data quota status updates from Active to Exhausted, and the device won’t be able to consume from the data service. Established connections for that device disconnects within seconds, and new connection requests are denied until a new data quota is assigned or data quota management is disabled in the service profile.

It’s also possible to define an action on Throttle. This means the device can still use data services with less throughput.

1{
2    "timestamp": "2021-10-27T09:06:50.000Z",
3    "alert": true,
4    "description": "Quota volume is completely used up and data access denied for endpoint.",
5    "id": 1071715568978,
6    "event_type": {
7        "id": 19,
8        "description": "Quota used up"
9    },
10    "event_source": {
11        "id": 1,
12        "description": "Policy Control"
13    },
14    "event_severity": {
15        "id": 1,
16        "description": "Warn"
17    },
18    "organisation": {
19        "id": 649,
20        "name": "Test Org"
21    },
22    "endpoint": {
23        "id": 19565190,
24        "imei": "535561812785483",
25        "ip_address": "147.188.3.101",
26        "name": "Factory Test Sim 2",
27        "tags": null
28    },
29    "sim": {
30        "iccid": "6971715153842702145",
31        "id": 28734421,
32        "production_date": "2020-12-23T13:02:11.000Z"
33    },
34    "imsi": {
35        "id": 28726038,
36        "import_date": "2020-12-23T13:02:11.000Z",
37        "imsi": "341399783365891"
38    },
39    "detail": {
40        "quota": {
41            "threshold_percentage": 80,
42            "threshold_volume": 0.8,
43            "volume": "1.000000"
44        }
45    }
46}

Data quota enabled

Data quota management is enabled in a service profile.

All devices using this service profile need to have an active data quota assigned to use the data service. Devices without active data quotas disconnect within seconds. New connection requests are denied until a new data quota is assigned or data quota management is disabled in the service profile.

1{
2  "timestamp": "2022-07-14T13:32:49.046Z",
3  "alert": false,
4  "description": "Data quota management enabled for service profile (id = 99133 - Generic Service Profile), endpoints of this service profile without an active data quota will be throttled or blocked from data service.",
5  "id": 215900319904123,
6  "event_type": {
7    "id": 52,
8    "description": "Data quota enabled"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 9684,
20    "name": "Example Org"
21  }
22}

Data quota disabled

Data quota management is disabled in a service profile.

There’s no longer data service restrictions for devices using this service profile.

1{
2  "timestamp": "2022-07-14T12:11:41.640Z",
3  "alert": false,
4  "description": "Data quota management disabled for service profile (id = 99133 - Generic Service Profile).",
5  "id": 2990738287492,
6  "event_type": {
7    "id": 53,
8    "description": "Data quota disabled"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 604,
20    "name": "Example Org"
21  }
22}

Data quota assigned

New data quota is assigned to a device.

Assigning a new data quota to a device is possible at any time. Data quota management must be enabled in the service profile.

Example: a device has a quota volume of 50 MB with daily auto-refill enabled, valid until May 27, 2025, and action on exhaustion set to block. The event description reads: “Data quota got assigned with a volume of 50.000000 MB with daily refill till 2025-05-27T22:56:17Z. On exhaustion, the data service will be blocked.”

1{
2  "timestamp": "2022-07-14T13:35:07.626Z",
3  "alert": false,
4  "description": "Data quota assigned with volume of 10.000000 MB without daily refill until 2022-07-31T00:00:00Z and action on exhaustion set to blocking.",
5  "id": 1028076751946,
6  "event_type": {
7    "id": 56,
8    "description": "Data quota assigned"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 2256,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 5293531,
24    "imei": "5839369400489068",
25    "ip_address": "188.167.183.228",
26    "name": "Test Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "8412861332142732293",
31    "id": 935826,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 186306,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "175971182377611"
38  },
39  "detail": {
40    "quota": {
41      "status": {
42        "id": 1,
43        "description": "ACTIVE"
44      },
45      "action_on_exhaustion": {
46        "id": 1,
47        "description": "Block",
48        "peak_throughput": 128000
49      },
50      "volume": 10,
51      "expiryDate": "2022-07-31T00:00:00Z",
52      "lastVolumeAdded": 10,
53      "lastStatusChangeDate": "2022-07-14T13:35:06Z",
54      "autoRefill": false,
55      "thresholdPercentage": 10,
56      "thresholdVolume": 1
57    }
58  }
59}
1{
2  "timestamp": "2022-07-14T13:38:11.537Z",
3  "alert": false,
4  "description": "Data quota assigned with volume of 100.000000 MB without daily refill until 2022-07-14T13:39:00Z and action on exhaustion set to throttling to a throughput of 128 kbit/s.",
5  "id": 55632453271862,
6  "event_type": {
7    "id": 56,
8    "description": "Data quota assigned"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 2782,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 5477169,
24    "imei": "2220624023468711",
25    "ip_address": "174.249.170.160",
26    "name": "Example Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "1013367122100019039",
31    "id": 899958,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 943048,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "209549041950251"
38  },
39  "detail": {
40    "quota": {
41      "status": {
42        "id": 1,
43        "description": "ACTIVE"
44      },
45      "action_on_exhaustion": {
46        "id": 2,
47        "description": "Throttle",
48        "peak_throughput": 128000
49      },
50      "volume": 100,
51      "expiryDate": "2022-07-14T13:39:00Z",
52      "lastVolumeAdded": 100,
53      "lastStatusChangeDate": "2022-07-14T13:38:11Z",
54      "autoRefill": false,
55      "thresholdPercentage": 15,
56      "thresholdVolume": 15
57    }
58  }
59}

Data quota deleted

Data quota is deleted from a device.

Once deleted, devices on this service profile with data quota management enabled won’t be able to use the data service. Potential data connections of this device disconnect within seconds. New connection requests are denied until an active data quota is assigned or data quota management is disabled in the service profile.

1{
2  "timestamp": "2022-07-14T13:35:18.686Z",
3  "alert": false,
4  "description": "Data quota deleted.",
5  "id": 44285280402507,
6  "event_type": {
7    "id": 57,
8    "description": "Data quota deleted"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 7806,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 387316,
24    "imei": "9044128511360644",
25    "ip_address": "174.238.2.179",
26    "name": "Example Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "7626384783536271949",
31    "id": 949644,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 108458,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "236366434880861"
38  }
39}

Data quota expired

Active data quota of a device expired and the quota status changed to Expired. Once expired, the device isn’t able to establish a data session.

1{
2  "timestamp": "2022-07-14T13:39:03.199Z",
3  "alert": true,
4  "description": "Data quota expired.",
5  "id": 35944374073138,
6  "event_type": {
7    "id": 60,
8    "description": "Data quota expired"
9  },
10  "event_source": {
11    "id": 1,
12    "description": "Policy Control"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 8238,
20    "name": "Example Org"
21  },
22  "endpoint": {
23    "id": 501389,
24    "imei": "8134820216492081",
25    "ip_address": "227.147.158.142",
26    "name": "Example Device",
27    "tags": null
28  },
29  "sim": {
30    "iccid": "3694452932824047676",
31    "id": 103965,
32    "production_date": "2017-05-03T20:36:28.000Z"
33  },
34  "imsi": {
35    "id": 357765,
36    "import_date": "2017-05-03T20:36:28.000Z",
37    "imsi": "29821710188733"
38  }
39}