Skip to main content

Deep summary event reports

Deep summary reports contain the same kind of information as the regular summary reports, but in a more detailed way. Summary reports can answer questions like "how many seats in Channel1 have the status 'booked'? The deep summary reports go further: "how many seats in Channel1 within Section A have the status 'booked'?

caution

If your account was created before July 12th 2022, the deep summary reports count tables that are bookable as a whole as 1 object. So if your event has 5 tables that are bookable as a whole, their count in the reports is 5.

For newer accounts, the reports contain the sum of the seats at the tables. 5 tables of 6 seats count as 30. Get in touch if you would like to enable that behaviour on an old account.

Deep summary report by availability reason

This report allows you to figure out how many objects are still available, and how many are not - including the reason why they're not available.

That reason can be:

  • available (object is available, i.e. it's selectable for ticket buyers)
  • booked (object is booked)
  • reservedByToken (object is held)
  • a custom status (object is assigned a custom status)
  • not_for_sale (object is marked as not for sale)

Objects that have a non-free status AND are marked as not for sale get that custom status as availability reason (instead of not_for_sale).

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byAvailabilityReason/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byAvailabilityReason/summary/deep -u aSecretKey: 
{
"available": {
"count": 15,
"bySection": {
"NO_SECTION": {
"count": 15,
"byChannel": {
"NO_CHANNEL": 14,
"channel2": 1
},
"byCategoryKey": {
"2": 1,
"3": 13,
"NO_CATEGORY": 1
},
"byStatus": {
"free": 15
},
"byCategoryLabel": {
"cat2": 1,
"cat3": 13,
"NO_CATEGORY": 1
},
"byObjectType": {
...
}
}
},
"byChannel": {
"NO_CHANNEL": {
"bySection": {
"NO_SECTION": 14
},
"count": 14,
"byCategoryKey": {
"3": 13,
"NO_CATEGORY": 1
},
"byStatus": {
"free": 14
},
"byCategoryLabel": {
"cat3": 13,
"NO_CATEGORY": 1
},
"byObjectType": {
...
}
},
"channel2": {
"bySection": {
"NO_SECTION": 1
},
"count": 1,
"byCategoryKey": {
"2": 1
},
"byStatus": {
"free": 1
},
"byCategoryLabel": {
"cat2": 1
},
"byObjectType": {
...
}
}
},
"byCategoryKey": {
...
},
"byStatus": {
...
},
"byCategoryLabel": {
...
},
"byObjectType": {
...
}
},
"booked": {
...
},
"reservedByToken": {
...
},
"not_for_sale": {
...
}
}

Deep summary report by availability

This report allows you to distinguish between available and non-available objects. An object is considered available if:

  • its status equals 'free'
  • it's for sale

Available objects can be found under the available key, non-available objects under not_available.

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byAvailability/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byAvailability/summary/deep -u aSecretKey: 
{
"available": {
"count": 15,
"bySection": {
"NO_SECTION": {
"count": 15,
"byChannel": {
"NO_CHANNEL": 14,
"channel2": 1
},
"byCategoryKey": {
"2": 1,
"3": 13,
"NO_CATEGORY": 1
},
"byStatus": {
"free": 15
},
"byCategoryLabel": {
"cat2": 1,
"cat3": 13,
"NO_CATEGORY": 1
},
"byObjectType": {
...
}
}
},
"byChannel": {
"NO_CHANNEL": {
"bySection": {
"NO_SECTION": 14
},
"count": 14,
"byCategoryKey": {
"3": 13,
"NO_CATEGORY": 1
},
"byStatus": {
"free": 14
},
"byCategoryLabel": {
"cat3": 13,
"NO_CATEGORY": 1
},
"byObjectType": {
...
}
},
"channel2": {
"bySection": {
"NO_SECTION": 1
},
"count": 1,
"byCategoryKey": {
"2": 1
},
"byStatus": {
"free": 1
},
"byCategoryLabel": {
"cat2": 1
},
"byObjectType": {
...
}
}
},
"byCategoryKey": {
...
},
"byStatus": {
...
},
"byCategoryLabel": {
...
},
"byObjectType": {
...
}
},
"not_available": {
...
}
}

Deep summary report by status

info

Most likely you'll want to use the deep summary report by availability reason instead of the one by status.

The availability reason gives detailed info on why an object is not available: either because it has a non-free status, or because it's not for sale. In the report by status, objects that are not for sale are considered free (since technically that is their status).

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byStatus/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byStatus/summary/deep -u aSecretKey: 

Example response

{
"booked": {
"count": 9,
"bySection": {
"NO_SECTION": {
"count": 9,
"byChannel": {
"NO_CHANNEL": 7,
"channel1": 2
},
"byCategoryKey": {
"1": 2,
"3": 7
},
"byAvailability": {
"not_selectable": 9
},
"byCategoryLabel": {
"cat3": 7,
"cat1": 2
},
"byObjectType": {
...
}
}
},
"byChannel": {
"NO_CHANNEL": {
"bySection": {
"NO_SECTION": 7
},
"count": 7,
"byCategoryKey": {
"3": 7
},
"byAvailability": {
"not_selectable": 7
},
"byCategoryLabel": {
"cat3": 7
},
"byObjectType": {
...
}
},
"channel1": {
"bySection": {
"NO_SECTION": 2
},
"count": 2,
"byCategoryKey": {
"1": 2
},
"byAvailability": {
"not_selectable": 2
},
"byCategoryLabel": {
"cat1": 2
},
"byObjectType": {
...
}
}
},
"byCategoryKey": {
...
},
"byAvailability": {
...
},
"byCategoryLabel": {
...
},
"byObjectType": {
...
}
},
"free": {
...
}
}

Deep summary report by category label

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byCategoryLabel/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byCategoryLabel/summary/deep -u aSecretKey: 
{
"count": 2,
"cat1": {
"bySection": {
"NO_SECTION": {
"count": 2,
"byChannel": {
"channel1": 2
},
"byCategoryKey": {
"1": 2
},
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byObjectType": {
...
}
}
},
"byChannel": {
"channel1": {
"bySection": {
"NO_SECTION": 2
},
"count": 2,
"byCategoryKey": {
"1": 2
},
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byObjectType": {
...
}
}
},
"byAvailability": {
...
},
"byStatus": {
...
},
"byObjectType": {
...
}
},
"cat2": {
...
},
"NO_CATEGORY": {
...
}
}

Deep summary report by category key

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byCategoryKey/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byCategoryKey/summary/deep -u aSecretKey: 
{
"count": 2,
"1": {
"bySection": {
"NO_SECTION": {
"count": 2,
"byChannel": {
"channel1": 2
},
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byCategoryLabel": {
"cat1": 2
},
"byObjectType": {
...
}
}
},
"byChannel": {
"channel1": {
"bySection": {
"NO_SECTION": 2
},
"count": 2,
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byCategoryLabel": {
"cat1": 2
},
"byObjectType": {
...
}
}
},
"byAvailability": {
...
},
"byStatus": {
...
},
"byObjectType": {
...
}
},
"2": {
...
},
"NO_CATEGORY": {
...
}
}

Deep summary report by section

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/bySection/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/bySection/summary/deep -u aSecretKey: 
{
"section1": {
"count": 2,
"byChannel": {
"NO_CHANNEL": {
"count": 2,
"byCategoryKey": {
"NO_CATEGORY": 2
},
"byAvailability": {
"available": 2
},
"byStatus": {
"free": 2
},
"byCategoryLabel": {
"NO_CATEGORY": 2
},
"byObjectType": {
...
}
}
},
"byCategoryKey": {
"NO_CATEGORY": {
"count": 2,
"byChannel": {
"NO_CHANNEL": 2
},
"byAvailability": {
"available": 2
},
"byStatus": {
"free": 2
},
"byObjectType": {
...
}
}
},
"byAvailability": {
...
},
"byStatus": {
...
},
"byCategoryLabel": {
...
},
"byObjectType": {
...
}
},
"section2": {
...
},
"NO_SECTION": {
...
}
}

Deep summary report by channel

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byChannel/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byChannel/summary/deep -u aSecretKey: 
{
"channel1": {
"count": 2,
"bySection": {
"NO_SECTION": {
"count": 2,
"byCategoryKey": {
"1": 2
},
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byCategoryLabel": {
"cat1": 2
},
"byObjectType": {
...
}
}
},
"byCategoryKey": {
"1": {
"bySection": {
"NO_SECTION": 2
},
"count": 2,
"byAvailability": {
"not_available": 2
},
"byStatus": {
"booked": 2
},
"byObjectType": {
...
}
}
},
"byAvailability": {
...
},
"byStatus": {
...
},
"byCategoryLabel": {
...
},
"byObjectType": {
...
}
},
"channel2": {
...
},
"NO_CHANNEL": {
...
},
}

Deep summary report by object type

GET https://api-{region}.seatsio.net/reports/events/{eventKey}/byObjectType/summary/deep
curl https://api-{region}.seatsio.net/reports/events/event34/byObjectType/summary/deep -u aSecretKey: 

Example response

{
"seat": {
"count": 9,
"bySection": {
"NO_SECTION": {
"count": 9,
"byChannel": {
"NO_CHANNEL": 7,
"channel1": 2
},
"byCategoryKey": {
"1": 2,
"3": 7
},
"byAvailability": {
"not_available": 9
},
"byCategoryLabel": {
"cat3": 7,
"cat1": 2
}
}
},
"byChannel": {
"NO_CHANNEL": {
"bySection": {
"NO_SECTION": 7
},
"count": 7,
"byCategoryKey": {
"3": 7
},
"byAvailability": {
"not_available": 7
},
"byCategoryLabel": {
"cat3": 7
}
},
"channel1": {
"bySection": {
"NO_SECTION": 2
},
"count": 2,
"byCategoryKey": {
"1": 2
},
"byAvailability": {
"not_available": 2
},
"byCategoryLabel": {
"cat1": 2
}
}
},
"byCategoryKey": {
...
},
"byAvailability": {
...
},
"byCategoryLabel": {
...
}
},
"generalAdmission": {
...
},
"table": {
...
},
"booth": {
...
}
}