Analytics

Endpoints


Get alert counts by facilities

POST/analytics/facility/alert/count

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID optional Id of the facility

Returns

Aggregated alert counts between given dates and comparison with previous aggregation

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "156bd472-07a6-4680-8e17-11816681e14a",
"value": 254
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": [
{
"previous": 2437,
"current": 1035,
"percentageChange": -0.5752974969224456,
"key": "156bd472-07a6-4680-8e17-11816681e14a"
}
]
}
}

Get alert count and type per facility

POST/analytics/facility/alert/type/count

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID optional Id of the facility

Returns

Aggregated alert counts and types between given dates and comparison with previous aggregation

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "156bd472-07a6-4680-8e17-11816681e14a",
"value": [
{
"type": "STATIC_DELIMITATION_AREA",
"value": 666
}
]
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": [
{
"key": "156bd472-07a6-4680-8e17-11816681e14a",
"previous": [
{
"type": "STATIC_DELIMITATION_AREA",
"value": 2071
}
],
"current": [
{
"type": "STATIC_DELIMITATION_AREA",
"value": 666
}
],
"percentageChange": [
{
"type": "STATIC_DELIMITATION_AREA",
"value": -0.6784162240463544
}
]
}
]
}
}

Get alert count by cameras

POST/analytics/camera/alert/count

Roles:

facilities:read

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID required Id of the facility

Returns

Aggregated alert counts between given dates and comparison with previous aggregation

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "ef02005c-4c7f-430e-b285-84e95ac8509e",
"value": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 25
}
]
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": [
{
"key": "ef02005c-4c7f-430e-b285-84e95ac8509e",
"previous": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 28
}
],
"current": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 25
}
],
"percentageChange": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": -0.6785714285714286
}
]
}
]
}
}

Get alert count by types

POST/analytics/alert/type/count

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID optional Id of the facility

Returns

Aggregated alert counts between given dates and comparison with previous aggregation

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 61
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": {
"previous": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 360
}
],
"current": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 361
}
],
"percentageChange": [
{
"type": "UNATTENDED_OBJECT_DETECTION",
"value": 0.002777777777777778
}
]
}
}
}

Get alert super category distribution

POST/analytics/alert/supercategory/count

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID optional Id of the facility
  • aggregate Enum optional
    • day
    • week
    • month Aggregation identifier

Returns

Aggregated alert counts between given dates and comparison with previous aggregation if aggregate parameter is present in the request

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"type": "AREA_CONTROLS",
"value": 189
},
{
"type": "ANOMALY",
"value": 61
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": {
"previous": [
{
"type": "AREA_CONTROLS",
"value": 1910
},
{
"type": "ANOMALY",
"value": 313
}
],
"current": [
{
"type": "AREA_CONTROLS",
"value": 625
},
{
"type": "ANOMALY",
"value": 315
}
],
"percentageChange": [
{
"type": "AREA_CONTROLS",
"value": -0.6727748691099477
},
{
"type": "ANOMALY",
"value": 0.006389776357827476
}
]
}
}
}

Total alert counts between given dates if aggregate parameter is not present in the request

{
"status": "ok",
"data": [
{
"type": "PPE",
"count": 8
},
{
"type": "AREA_CONTROLS",
"count": 666
},
{
"type": "ANOMALY",
"count": 361
}
]
}

Get severity distribution

POST/analytics/alert/severity/count

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID optional Id of the facility
  • aggregate Enum optional
    • day
    • week
    • month Aggregation identifier

Returns

Aggregated alert counts between given dates and comparison with previous aggregation if aggregate parameter is present in the request

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"type": "HIGH",
"value": 1
},
{
"type": "LOW",
"value": 132
},
{
"type": "MEDIUM",
"value": 121
}
],
"start": 1619395200,
"end": 1619481600,
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Tue, 27 Apr 2021 00:00:00 +0000"
}
],
"comparison": {
"previous": [
{
"type": "HIGH",
"value": 32
},
{
"type": "MEDIUM",
"value": 1873
},
{
"type": "LOW",
"value": 532
}
],
"current": [
{
"type": "HIGH",
"value": 10
},
{
"type": "MEDIUM",
"value": 683
},
{
"type": "LOW",
"value": 342
}
],
"percentageChange": [
{
"type": "HIGH",
"value": -0.6875
},
{
"type": "MEDIUM",
"value": -0.6353443673251469
},
{
"type": "LOW",
"value": -0.35714285714285715
}
]
}
}
}

Total alert counts between given dates if aggregate parameter is not present in the request

{
"status": "ok",
"data": {
"data": [
{
"key": "HIGH",
"value": 10
},
{
"key": "LOW",
"value": 342
},
{
"key": "MEDIUM",
"value": 683
}
]
}
}

Get alerts by shift count

POST/analytics/alert/shift_count

Arguments

BODY PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID required Id of the facility

Returns

{
"status": "ok",
"data": {
"series": {
"groups": [
{
"key": "0",
"value": 101
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 75
}
]
},
"comparison": {
"previous": [
{
"key": "0",
"value": 86
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 74
}
],
"current": [
{
"key": "0",
"value": 101
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 75
}
],
"percentageChange": [
{
"key": "0",
"value": 0.1744186046511628
},
{
"key": "1",
"value": 0
},
{
"key": "2",
"value": 0.013513513513513514
}
]
}
}
}

Get alerts per type by shift count

POST/analytics/alert/shift_count_per_type

Arguments

BODY PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID required Id of the facility

Returns

{
"status": "ok",
"data": {
"series": {
"groups": [
{
"key": "0",
"value": [
{
"type": "FACE_MASK",
"value": 21
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 53
},
{
"type": "RESTRICTED_HEIGHT",
"value": 14
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 13
}
]
},
{
"key": "1",
"value": [
{
"type": "FACE_MASK",
"value": 15
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 60
},
{
"type": "RESTRICTED_HEIGHT",
"value": 9
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 13
}
]
},
{
"key": "2",
"value": [
{
"type": "FACE_MASK",
"value": 11
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 38
},
{
"type": "RESTRICTED_HEIGHT",
"value": 11
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 15
}
]
}
]
},
"comparison": {
"previous": [
{
"key": "0",
"value": [
{
"type": "RESTRICTED_HEIGHT",
"value": 24
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 50
},
{
"type": "FACE_MASK",
"value": 7
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 5
}
]
},
{
"key": "1",
"value": [
{
"type": "FACE_MASK",
"value": 13
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 53
},
{
"type": "RESTRICTED_HEIGHT",
"value": 24
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 7
}
]
},
{
"key": "2",
"value": [
{
"type": "FACE_MASK",
"value": 8
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 43
},
{
"type": "RESTRICTED_HEIGHT",
"value": 13
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 10
}
]
}
],
"current": [
{
"key": "0",
"value": [
{
"type": "FACE_MASK",
"value": 21
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 53
},
{
"type": "RESTRICTED_HEIGHT",
"value": 14
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 13
}
]
},
{
"key": "1",
"value": [
{
"type": "FACE_MASK",
"value": 15
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 60
},
{
"type": "RESTRICTED_HEIGHT",
"value": 9
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 13
}
]
},
{
"key": "2",
"value": [
{
"type": "FACE_MASK",
"value": 11
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 38
},
{
"type": "RESTRICTED_HEIGHT",
"value": 11
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 15
}
]
}
],
"percentageChange": [
{
"key": "0",
"value": [
{
"type": "FACE_MASK",
"value": 2
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 0.06
},
{
"type": "RESTRICTED_HEIGHT",
"value": -0.4166666666666667
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 1.6
}
]
},
{
"key": "1",
"value": [
{
"type": "FACE_MASK",
"value": 0.15384615384615385
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": 0.1320754716981132
},
{
"type": "RESTRICTED_HEIGHT",
"value": -0.625
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 0.8571428571428571
}
]
},
{
"key": "2",
"value": [
{
"type": "FACE_MASK",
"value": 0.375
},
{
"type": "CONTACT_WITH_ELECTRICITY",
"value": -0.11627906976744186
},
{
"type": "RESTRICTED_HEIGHT",
"value": -0.15384615384615385
},
{
"type": "STATIC_DELIMITATION_AREA",
"value": 0.5
}
]
}
]
}
}
}

Get alerts by shift count aggregated

POST/analytics/alert/shift_count_aggregated

Arguments

BODY PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID required Id of the facility
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier

Returns

{
"status": "ok",
"data": {
"series": [
{
"start": 1619395200,
"end": 1619481599.999,
"groups": [
{
"key": "0",
"value": 17
},
{
"key": "1",
"value": 18
},
{
"key": "2",
"value": 16
}
],
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Mon, 26 Apr 2021 23:59:59 +0000"
}
],
"comparison": {
"previous": [
{
"key": "0",
"value": 86
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 74
}
],
"current": [
{
"key": "0",
"value": 101
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 75
}
],
"percentageChange": [
{
"key": "0",
"value": 0.1744186046511628
},
{
"key": "1",
"value": 0
},
{
"key": "2",
"value": 0.013513513513513514
}
]
}
}
}

Get alerts per type by shift count aggregated

POST/analytics/alert/shift_count_per_type_aggregated

Arguments

BODY PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID required Id of the facility
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier

Returns

{
"status": "ok",
"data": {
"series": [
{
"start": 1619395200,
"end": 1619481599.999,
"groups": [
{
"key": "0",
"value": 17
},
{
"key": "1",
"value": 18
},
{
"key": "2",
"value": 16
}
],
"humanStartDate": "Mon, 26 Apr 2021 00:00:00 +0000",
"humanEndDate": "Mon, 26 Apr 2021 23:59:59 +0000"
}
],
"comparison": {
"previous": [
{
"key": "0",
"value": 86
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 74
}
],
"current": [
{
"key": "0",
"value": 101
},
{
"key": "1",
"value": 97
},
{
"key": "2",
"value": 75
}
],
"percentageChange": [
{
"key": "0",
"value": 0.1744186046511628
},
{
"key": "1",
"value": 0
},
{
"key": "2",
"value": 0.013513513513513514
}
]
}
}
}

Get alert summary

GET/analytics/alert/summary

Roles:

cameras:readalerts:read

Arguments

QUERY STRING PARAMETERS
  • facilityId UUID optional Id of the facility

Returns

{
"status": "ok",
"data": {
"daily": 10,
"weekly": 58,
"monthly": 194
}
}

Get facility compliance

POST/analytics/compliance/facility

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • alertTypes List[Enum] optional
    • APRON
    • BANNISTER_USAGE
    • CLEAN_PEDESTRIAN_WAYS
    • CLEAN_VEHICLE_ROADS
    • CLIMBING
    • MAX_WORKER_IN_CONFINED_SPACE
    • MIN_WORKER_IN_CONFINED_SPACE
    • CONTACT_WITH_ELECTRICITY
    • CRANE_AREA
    • CUSTOM
    • DYNAMIC_DELIMITATION_AREA
    • EXCLUSION_ZONE
    • FACE_MASK
    • FIRE_DETECTION
    • GLASSES
    • GLOVE
    • GROUP
    • GROUPING
    • HELMET
    • LEAKAGE_AND_SPILL
    • LIGHT_CONTROLS
    • LINE_OF_FIRE
    • MACHINE_MAN_RESTRICTED_AREA
    • MANDOWN
    • MASK
    • OPEN_CLOSED_DOORS
    • PEDESTRIAN_WAY_VIOLATION
    • REFLECTIVE_VEST
    • RESTRICTED_HEIGHT
    • SCISSOR_LIFT_HELMET_USAGE
    • VEHICLE_PPE_COMPLIANCE
    • SLEEVE
    • SOCIAL_DISTANCE
    • SPEED_LIMIT
    • STATIC_DELIMITATION_AREA
    • TIME_LIMITED_AREA
    • UNATTENDED_OBJECT_DETECTION
    • VEHICLE_RESTRICTED_AREA
    • VEHICLE_OPERATION_ZONE
    • VEHICLE_NEAR_MISS

Returns

{
"status": "ok",
"data": {
"comparison": [
{
"key": "c6395c0d-a886-4830-808b-0f5e0d584252",
"current": 98.14662162162162,
"previous": 99.56643356643356,
"percentageChange": -0.01425994578649441
},
{
"key": "ec2d70bb-0f27-4b30-b8db-c4dab0e7bc62",
"current": 99.58379715522572,
"previous": 100,
"percentageChange": -0.004162028447742756
},
{
"key": "471c4c46-6789-43bc-91f3-79f6b6dd32ac",
"current": 99.34317343173431,
"previous": 44.53331126543608,
"percentageChange": 1.2307609878728725
}
]
}
}

Get camera compliance

POST/analytics/compliance/camera/type

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID required Id of the facility
  • alertTypes List[Enum] optional List of alert types
    • APRON
    • BANNISTER_USAGE
    • CLEAN_PEDESTRIAN_WAYS
    • CLEAN_VEHICLE_ROADS
    • CLIMBING
    • MAX_WORKER_IN_CONFINED_SPACE
    • MIN_WORKER_IN_CONFINED_SPACE
    • CONTACT_WITH_ELECTRICITY
    • CRANE_AREA
    • CUSTOM
    • DYNAMIC_DELIMITATION_AREA
    • EXCLUSION_ZONE
    • FACE_MASK
    • FIRE_DETECTION
    • GLASSES
    • GLOVE
    • GROUP
    • GROUPING
    • HELMET
    • LEAKAGE_AND_SPILL
    • LIGHT_CONTROLS
    • LINE_OF_FIRE
    • MACHINE_MAN_RESTRICTED_AREA
    • MANDOWN
    • MASK
    • OPEN_CLOSED_DOORS
    • PEDESTRIAN_WAY_VIOLATION
    • REFLECTIVE_VEST
    • RESTRICTED_HEIGHT
    • SCISSOR_LIFT_HELMET_USAGE
    • VEHICLE_PPE_COMPLIANCE
    • SLEEVE
    • SOCIAL_DISTANCE
    • SPEED_LIMIT
    • STATIC_DELIMITATION_AREA
    • TIME_LIMITED_AREA
    • UNATTENDED_OBJECT_DETECTION
    • VEHICLE_RESTRICTED_AREA
    • VEHICLE_OPERATION_ZONE
    • VEHICLE_NEAR_MISS

Returns

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "SOCIAL_DISTANCE",
"value": 98.0754716981132
}
],
"start": 1620086400,
"aggregation": "day",
"humanStartDate": "Tue, 4 May 2021 00:00:00 +0000",
"humanEndDate": "Tue, 4 May 2021 23:59:59 +0000",
"end": 1620172799.999
}
],
"comparison": [
{
"key": "SOCIAL_DISTANCE",
"current": 95.9956204379562,
"previous": 98.97237569060773,
"percentageChange": -0.030076627259681073
}
]
}
}

Get compliance by type

POST/analytics/compliance/type

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID optional Id of the facility
  • cameraId UUID optional Id of the camera
  • alertTypes List[Enum] optional List of alert types
    • APRON
    • BANNISTER_USAGE
    • CLEAN_PEDESTRIAN_WAYS
    • CLEAN_VEHICLE_ROADS
    • CLIMBING
    • MAX_WORKER_IN_CONFINED_SPACE
    • MIN_WORKER_IN_CONFINED_SPACE
    • CONTACT_WITH_ELECTRICITY
    • CRANE_AREA
    • CUSTOM
    • DYNAMIC_DELIMITATION_AREA
    • EXCLUSION_ZONE
    • FACE_MASK
    • FIRE_DETECTION
    • GLASSES
    • GLOVE
    • GROUP
    • GROUPING
    • HELMET
    • LEAKAGE_AND_SPILL
    • LIGHT_CONTROLS
    • LINE_OF_FIRE
    • MACHINE_MAN_RESTRICTED_AREA
    • MANDOWN
    • MASK
    • OPEN_CLOSED_DOORS
    • PEDESTRIAN_WAY_VIOLATION
    • REFLECTIVE_VEST
    • RESTRICTED_HEIGHT
    • SCISSOR_LIFT_HELMET_USAGE
    • VEHICLE_PPE_COMPLIANCE
    • SLEEVE
    • SOCIAL_DISTANCE
    • SPEED_LIMIT
    • STATIC_DELIMITATION_AREA
    • TIME_LIMITED_AREA
    • UNATTENDED_OBJECT_DETECTION
    • VEHICLE_RESTRICTED_AREA
    • VEHICLE_OPERATION_ZONE
    • VEHICLE_NEAR_MISS
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier

Returns

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "SOCIAL_DISTANCE",
"value": 98.0754716981132
}
],
"start": 1620086400,
"aggregation": "day",
"humanStartDate": "Tue, 4 May 2021 00:00:00 +0000",
"humanEndDate": "Tue, 4 May 2021 23:59:59 +0000",
"end": 1620172799.999
}
],
"comparison": [
{
"key": "SOCIAL_DISTANCE",
"current": 95.9956204379562,
"previous": 98.97237569060773,
"percentageChange": -0.030076627259681073
}
]
}
}

Get compliance by shift

POST/analytics/compliance/shift

Arguments

BODY
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier
  • facilityId UUID required Id of the facility
  • alertTypes List[Enum] optional List of alert types
    • APRON
    • BANNISTER_USAGE
    • CLEAN_PEDESTRIAN_WAYS
    • CLEAN_VEHICLE_ROADS
    • CLIMBING
    • MAX_WORKER_IN_CONFINED_SPACE
    • MIN_WORKER_IN_CONFINED_SPACE
    • CONTACT_WITH_ELECTRICITY
    • CRANE_AREA
    • CUSTOM
    • DYNAMIC_DELIMITATION_AREA
    • EXCLUSION_ZONE
    • FACE_MASK
    • FIRE_DETECTION
    • GLASSES
    • GLOVE
    • GROUP
    • GROUPING
    • HELMET
    • LEAKAGE_AND_SPILL
    • LIGHT_CONTROLS
    • LINE_OF_FIRE
    • MACHINE_MAN_RESTRICTED_AREA
    • MANDOWN
    • MASK
    • OPEN_CLOSED_DOORS
    • PEDESTRIAN_WAY_VIOLATION
    • REFLECTIVE_VEST
    • RESTRICTED_HEIGHT
    • SCISSOR_LIFT_HELMET_USAGE
    • VEHICLE_PPE_COMPLIANCE
    • SLEEVE
    • SOCIAL_DISTANCE
    • SPEED_LIMIT
    • STATIC_DELIMITATION_AREA
    • TIME_LIMITED_AREA
    • UNATTENDED_OBJECT_DETECTION
    • VEHICLE_RESTRICTED_AREA
    • VEHICLE_OPERATION_ZONE
    • VEHICLE_NEAR_MISS
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier

Returns

{
"status": "ok",
"data": {
"series": [
{
"groups": [
{
"key": "0",
"value": 99.75
},
{
"key": "2",
"value": 98.36363636363636
},
{
"key": "1",
"value": 100
}
],
"start": 1620086400,
"aggregation": "day",
"key": 1620086400,
"humanStartDate": "Tue, 4 May 2021 00:00:00 +0000",
"humanEndDate": "Tue, 4 May 2021 23:59:59 +0000",
"end": 1620172799.999
}
],
"comparison": [
{
"key": "0",
"current": 98.02627257799672
},
{
"key": "2",
"current": 97.92037786774628,
"previous": 100,
"percentageChange": -0.020796221322537178
},
{
"key": "1",
"current": 100,
"previous": 99.36082474226804,
"percentageChange": 0.006432869890018725
}
],
"comparisonNew": {
"current": [
{
"key": "0",
"value": 99.35
}
]
}
}
}

Get compliance by best/worst by facility

POST/analytics/compliance/best_worst

Arguments

BODY PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • n Int required Get n best/worst facilities
  • aggregate Enum required
    • day
    • week
    • month Aggregation identifier

Returns

{
"status": "ok",
"data": {
"best": [
{
"current": 100,
"previous": 100,
"percentageChange": 0,
"facilityId": "ec2d70bb-0f27-4b30-b8db-c4dab0e7bc62",
"alertTypeId": "FACE_MASK",
"key": "ec2d70bb-0f27-4b30-b8db-c4dab0e7bc62-FACE_MASK"
}
],
"worst": [
{
"current": 21,
"facilityId": "ec2d70bb-0f27-4b30-b8db-c4dab0e7bc62",
"alertTypeId": "VEHICLE_PPE_COMPLIANCE",
"key": "ec2d70bb-0f27-4b30-b8db-c4dab0e7bc62-VEHICLE_PPE_COMPLIANCE"
}
]
}
}

Get overview use case per camera

GET/analytics/overview/use_case_per_camera

Roles:

overviewanalytics:read

Arguments

QUERY STRING PARAMETERS
  • start Long required Start of the timestamp
  • end Long required End of the timestamp
  • facilityId UUID optional Id of the facility

Returns

{
"status": "ok",
"data": {
"comparison": {
"current": {
"cameraCount": 10,
"alertRuleCount": 20,
"useCasePerCamera": 2.0
},
"previous": {
"cameraCount": 20,
"alertRuleCount": 60,
"useCasePerCamera": 3.0
},
"percentageChange": {
"cameraCount": -0.5,
"alertRuleCount": -0.67,
"useCasePerCamera": -0.33
}
}
}
}