Month Summary Endpoint

As you probably guessed, the monthly summary is a highlevel summary of the venue and zone statistics for a given month. Worth noting that the averages are based only on “open” days - the number of days that contain count data.

GET /api/1.0/monthSummaries/{venue_id}_{YYYY}-{MM}

Parameters:

• venue_id – The ID of the venue to query

• YYYY – Year

• MM – Month (1-12)

Response JSON Object:

• avg_peak – daily average peak for days in which the venue was open

• avg_peakTime – average seconds offset from opentime at which peak was hit (for open days only)

• avg_throughputFemale – average female throughput count (for open days)

• avg_throughputMale – average male throughput count (for open days)

• avg_timeToCapacity – average seconds offset from opentime at which capacity was hit (for open days that hit capacity only)

• daysHitCapacity – number of days this month that capacity was reached

• daysOpen – number of days this month that we have non-zero throughput

• max_peak – highest capacity reached during this month

• total_throughputFemale – total number of pink/female counts across all open days

• total_throughputMale – total number of blue/male counts across all open days

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

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

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

{
     "id": "1_2019-1",
     "month": "2019-1",
     "zones": {
         "2": {
             "avg_peak": 5,
             "avg_peakTime": 0,
             "avg_throughputFemale": 5,
             "avg_throughputMale": 0,
             "avg_timeToCapacity": null,
             "daysHitCapacity": 0,
             "daysOpen": 1,
             "max_peak": 5,
             "total_throughputFemale": 5,
             "total_throughputMale": 0,
         },
         "3": {
             "avg_peak": 0,
             "avg_peakTime": 0,
             "avg_throughputFemale": 0,
             "avg_throughputMale": 0,
             "avg_timeToCapacity": null,
             "daysHitCapacity": 0,
             "daysOpen": 1,
             "max_peak": 5,
             "total_throughputFemale": 0,
             "total_throughputMale": 0,
         }
     },

     "avg_peak": 5,
     "avg_peakTime": 0,
     "avg_throughputFemale": 5,
     "avg_throughputMale": 5,
     "avg_timeToCapacity": null,
     "daysHitCapacity": 0,
     "daysOpen": 1,
     "max_peak": 5,
     "total_throughputFemale": 5,
     "total_throughputMale": 0,
 }