Day Summary Endpoint

The Day Summary endpoint is an involved analysis endpoint. It is intended to be used infrequently to get the updated statistics for a completed day. The endpoint can be queried for in-progress days, and will provide valid information, but this is not a polled endpoint.

This is a read-only endpoint, and you are expected to poll no more frequently than once per 10 second interval. Data is provided for the combined venue, and contains substructures each of the associated zones. i.e. there is no zone day summary endpoint.

GET /api/1.0/daySummaries/{venue_id}_{YYYY}-{MM}-{DD}

Parameters:

• venue_id – The ID of the venue to query

• YYYY – Year

• MM – Month (1-12)

• DD – Date (1-31)

Response JSON Object:

• openTime – Unix Timestamp (seconds since 1970), denoting day start

• peak – Peak Total Count

• peakTime – time offset from openTime in seconds to when the peak total count was first hit

• timeToCapacity – time offset from openTime in seconds to when the the venue’s capacity was first hit, null if capacity was never hit

• throughputMale – Total number of entrace counts (blue/male)

• throughputFemale – Total number of entrace counts (pink/female)

• exitsMale – Total number of exit counts (blue/male)

• exitsFemale – Total number of exit counts (pink/female)

• revenue – Revenue Amount in $ specified on the dashboard calendar

• notes – Note text specified from dashboard calendar

• zones – Summary for each of the associated zones (dictionary, with key=zone_id)

• devices – Device name cache (id -> name mapping that was valid on date)

• form – Custom json object that can be used to store day-specific information for editing and recall

• e.g. Fetch Day Summary for for Venue 1 on Jan 1, 2019

GET /api/1.0/daySummaries/1_2019-01-01 HTTP/1.1
apikey: 123456789

HTTP/1.1 200 OK
Content-Type: application/json;

{
 "daySummary": {
     "id": "1_2019-1-1",
     "date": "2019-1-1",

     "openTime": 1546866000.0,

     "peak": 5,
     "peakTime": 0,
     "timeToCapacity": null,

     "throughputMale": 0,
     "throughputFemale": 5,
     "exitsMale": 0,
     "exitsFemale": 0,

     "revenue": 0,
     "notes": "",
     "zones": {
         "1": {
             "peak": 5,
             "peakTime": 0,
             "timeToCapacity": null,
             "throughputMale": 0,
             "throughputFemale": 5,
             "exitsMale": 0,
             "exitsFemale": 0,
         },
     },
     "devices": {
                 "1": "Front Door"
     },
     "form": {}
  }
 }