2. Home
  4. Docs
  6. IoTGtw API Samples
  8. Provisioning API (Manage Account, Devices, Service Templates, Endpoint Profiles)
  10. Analytics

Analytics

Count the total number of devices on the account, group the result by device state and service template
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
"request_id": "129922929",
"customer_id": "5a393ea210d91806b7ef702c",
"request_parameters": {
"count_operation": "devices",
"group_by": ["state", "service_template_id"]
}
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "devices": [
            {
                "_id": {
                    "state": true,
                    "service_template_id": "raspberry_pi_service_conf"
                },
                "count": 1
            },
            {
                "_id": {
                    "state": false,
                    "service_template_id": "config_profile_utililty_group1"
                },
                "count": 1
            },
            {
                "_id": {
                    "state": true,
                    "service_template_id": "config_profile_utililty_group1"
                },
                "count": 3
            },
            {
                "_id": {
                    "state": true,
                    "service_template_id": "config_profile_SmartDev_r22"
                },
                "count": 4
            }
        ]
    }
}

Note:
When performing device count operation, the group_by attribute can be any combination of ["state", "service_template_id", "service_access_point", "device_app_protocol"];
Count the total number of devices configured with the specified service_template_id group by device state
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"devices",
      "group_by":[
         "state"
      ],
      "service_template_id":"config_profile_utililty_group1"
   }
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "devices": [
            {
                "_id": {
                    "state": false
                },
                "count": 1
            },
            {
                "_id": {
                    "state": true
                },
                "count": 3
            }
        ]
    }
}

Count the total number of devices using the specified SAP
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"devices",
      "service_access_point":"doodle"
   }
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "devices": [
            {
                "_id": {},
                "count": 5
            }
        ]
    }
}

Analyse the total number of messages in the “pending” queue of all devices
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"129922929",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"pending",
      "group_by":[
         "service_access_point"
      ]
   }
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "shipped_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 11
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 63798
            }
        ]
    }
}

Note:
When performing messaging count analytics granular count operation can be requested by specifying whether to count all queues, specific queues or specific queues and uplink or downlink traffic. The count operation must be specified as one of the following: [“all_queues” or “pending” or “pending_uplink” or “pending_downlink” or “shipped” or “shipped_uplink” or “shipped_downlink” or “failed” or “fiailed_uplink” or “failed_downlink”]
The group_by attribute can be any combination of [“service_template_id”, “service_access_point”, “device_app_protocol”, “msg_submit_status”, “delivery_type”, “device_tx_protocol”, “transaction_type”]
Analyse the total number of messages in “all_queues” of all devices
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
"request_id":"129922929",
"customer_id":"5a393ea210d91806b7ef702c",
"request_parameters": {
"count_operation": "all_queues",
"group_by": ["service_access_point"]
}
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "shipped_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 11
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 63798
            }
        ],
        "failed_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 1
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 8
            }
        ],
        "pending_messages": [
            {
                "_id": {},
                "count": 0
            }
        ]
    }
}

Note:
• When performing messaging count analytics granular count operation can be requested by specifying whether to count all queues, specific queues or specific queues and uplink or downlink traffic. The count operation must be specified as one of the following: [“all_queues” or “pending” or “pending_uplink” or “pending_downlink” or “shipped” or “shipped_uplink” or “shipped_downlink” or “failed” or “fiailed_uplink” or “failed_downlink”]
• The group_by attribute can be any combination of [“service_template_id”, “service_access_point”, “device_app_protocol”, “msg_submit_status”, “delivery_type”, “device_tx_protocol”, “transaction_type”]
Analyse the total number of messages in “all_queues” of all devices that were sent/received within the specified start and end date
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"129922929",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"all_queues",
      "group_by":[
         "service_access_point"
      ],
      "start_date":"2015-01-25T10:00:00.000Z",
      "end_date":"2015-01-30T10:00:00.000Z"
   }
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "shipped_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 11
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 5600
            }
        ],
        "failed_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 0
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 0
            }
        ],
        "pending_messages": [
            {
                "_id": {
                    "service_access_point": "doodle"
                },
                "count": 2
            },
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 1
            }        
         ]
    }
}

Analyse the total number of messages in the “shipped” queue of a specific device that were sent/received within the specified start and end date.
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"129922929",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"shipped",
      "group_by":[
         "service_access_point"
      ],
      "udid":"5a623f4ddd59545193ea9b6c ",
      "start_date":"2015-01-25T10:00:00.000Z",
      "end_date":"2015-01-30T10:00:00.000Z"
   }
}

Sample Response

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "request_id": "",
    "result_code": 0,
    "result_description": "Success",
    "response": {
        "shipped_messages": [
            {
                "_id": {
                    "service_access_point": "faniot"
                },
                "count": 89
            }
        ]
    }
}

Analyse the total number of messages that matches the specified criteria (Example of supported message filter criteria).
Property Description
Resource URL /customer/v1/{customer_id}/service_provisioning/count
Method POST
Body Count Object
Sample Request

Count Analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/count
 
HEADER
authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw
 
{
   "request_id":"129922929",
   "customer_id":"5a393ea210d91806b7ef702c",
   "request_parameters":{
      "count_operation":"shipped",
      "group_by":[
 
      ],
      "device_id":"",
      "device_name":"",
      "udid":"",
      "imsi":"",
      "device_ip":"194.110.10.15",
      "service_template_id":"",
      "service_access_point":"",
      "start_date":"",
      "end_date":""
   }
}

Note:
• When performing messaging count analytics granular count operation can be requested by specifying whether to count all queues, specific queues or specific queues and uplink or downlink traffic. The count operation must be specified as one of the following: [“all_queues” or “pending” or “pending_uplink” or “pending_downlink” or “shipped” or “shipped_uplink” or “shipped_downlink” or “failed” or “fiailed_uplink” or “failed_downlink”]
• The group_by attribute can be any combination of [“service_template_id”, “service_access_point”, “device_app_protocol”, “msg_submit_status”, “delivery_type”, “device_tx_protocol”, “transaction_type”]
Was this article helpful to you? Yes No

How can we help?