Page Comparison

...

Type	Name	Required	Description	Schema
Path	projectId	YES	The ID of the project, e.g. 111	int
Body	start	YES	The start date of the desired time range, in ISO8601 RFC339Nano format	string
Body	end	YES	The end date of the desired time range, in ISO8601 RFC339Nano format	string

Response

Field Name	Nested Field Name	Description	Schema
population		The number of unique beacons observed within the requested time range	uint32
compliant		The percentage of unique beacon without any Distance Violations within the requested time range	float
violations		The number of distance tracking violations observed within the requested time range	uint32
uniqueDevices		The number of unique devices that have violated a Distance Violation policy within the requested time range	uint32
recent		An array of objects whose fields detail the recent distance violations by hour for the requested time range	[]DistanceViolationRollup
	interval	The rollup interval. Only HOURLY is available for now.	String
	timestamp	The timestamp of the rollup, formatted according to RFC3339	String
	population	The number of unique devices observed within this rollup	uint32
	violations	The number of Distance Violations within this rollup	uint32
	uniqueViolations	The number of unique devices which had at least one violation within this rollup	uint32
todaysViolations		An array of objects whose fields detail the location and corresponding count of Distance Violations for the requested time range	[]DistanceViolationAggregation
	lat	The latitude of the location of the Distance Violation	double
	lng	The longitude of the location of the Distance Violation	double
	count	The amount of Distance Violations at this location	uint32
topViolatingBeacons		An array of objects detailing the amount of Distance Violations per each device for the requested time range, sorted by count, descending	[]DistanceViolationBeacon
	id	The device ID	String
	violationCount	The amount of Distance Violations	uint32
topViolatingAreas		An array of objects detailing the amount of Distance Violations per each location for the requested time range, sorted by count, descending	[]DistanceViolationLocation
	name	The location name	String
	id	The location ID	uint64
	violationCount	The amount of Distance Violations	uint32

Sample Response

Code Block

{
  "population": 46, //The number of unique devices observed by Bluzone
  "compliant": 71.73913, //The percent of unique devices that do not have an associated Distance Tracking violation
  "violations": 26, //The number of Distance Tracking violations observed
  "uniqueDevices": 13, //The number of unique devices for which Bluzone observed a Distance Tracking violation
  "recent": [
    //Each entry is an hourly report of the observed population, violations, and unique devices with violations
    {
      "interval": "HOURLY",
      "timestamp": "2020-07-16T18:00:00Z",
      "population": 41,
      "violations": 2,
      "uniqueViolations": 2
    },
    {
      "interval": "HOURLY",
      "timestamp": "2020-07-16T19:00:00Z",
      "population": 40,
      "violations": 1,
      "uniqueViolations": 1
    },
    {
      "interval": "HOURLY",
      "timestamp": "2020-07-17T17:00:00Z",
      "population": 26,
      "violations": 2,
      "uniqueViolations": 2
    }
  ],
  "todaysViolations": [
    //Each entry is a unique latitude/longitude tuple and the number of associated Distance Tracking violations at that location
    {
      "lat": 30.413098,
      "lng": -97.666902,
      "count": 1
    },
    {
      "lat": 30.412875,
      "lng": -97.666004,
      "count": 1
    },
    {
      "lat": 30.412972,
      "lng": -97.666179,
      "count": 1
    }
  ],
  "topViolatingBeacons": [
    //Each entry is a unique device id and the number of associated Distance Tracking violations for this device
    {
      "id": "1376582239814772076",
      "violationCount": 1
    },
    {
      "id": "8195029735132899180",
      "violationCount": 1
    },
    {
      "id": "14147864550494974530",
      "violationCount": 1
    },
  ],
  "topViolatingAreas": [
    //Each entry is a unique Bluzone locationId, it's name, and the number of associated Distance Tracking violations for this location
    {
      "name": "My Location",
      "locationId": "111",
      "violationCount": 26
    }
  ]
}

...

Versions Compared

Old Version 5

New Version 6

Key

Response

Sample Response