Year Summary Endpoint

At the annual level, there is relatively little aggregated - mostly because our system does not visualize or compare years at depth. If additional metrics would be valuable at this level for your application, please let us know <api@tallyfi.com>

GET /api/1.0/yearSummaries/{venue_id}_{YYYY}

Parameters:

• venue_id – The ID of the venue to query

• YYYY – Year

Response JSON Object:

• id – yearSummary cache id

• year – the year the query matched

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

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

• zones – hash of zone_id to year summary data (each summarized zone supplies total throughput entries)

• e.g. Fetch Year Summary for Venue 1 for 2019

GET /api/1.0/yearSummaries/1_2019 HTTP/1.1
apikey: 123456789

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

{
 "yearSummary": {
     "id": "1_2019",
     "year": 2019,
     "total_throughputMale": 0,
     "total_throughputFemale": 5,
     "zones": {
         "2": {
             "total_throughputMale": 0,
             "total_throughputFemale": 5
         },
         "3": {
             "total_throughputMale": 0,
             "total_throughputFemale": 0
         }
     }
 }
}