BokaMera.API.Host

<back to all web services

StatisticQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/statistics
StatisticQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesEnter the company id, if blank company id and you are an admin, your company id will be used.
FromqueryDateTimeYesStart of interval to get bookings and customers
ToqueryDateTimeYesEnd of interval to get bookings and customers
IncludeOccuringBookingsByDayqueryboolNoSet true if you want to include booked events by day
IncludeBookingsCanceledByDayqueryboolNoSet true if you want to include canceled booked events by day
IncludeCreatedBookingsByDayqueryboolNoSet true if you want to include booking created by day
IncludeCreatedCustomersByDayqueryboolNoSet true if you want to include customers created by day
StatisticQueryResponse Parameters:
NameParameterData TypeRequiredDescription
NumberOfOccuringBookingsformintNo
NumberOfCanceledBookingsformintNo
NumberOfCreatedBookingsformintNo
NumberOfCreatedCustomersformintNo
OccuringBookingsByDayformList<BookedByDay>No
CanceledBookingsByDayformList<BookedByDay>No
CreatedBookingsByDayformList<BookedByDay>No
CreatedCustomersByDayformList<BookedByDay>No
ResponseStatusformResponseStatusNo
BookedByDay Parameters:
NameParameterData TypeRequiredDescription
DateformDateTimeNo
ValueformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /statistics HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"NumberOfOccuringBookings":0,"NumberOfCanceledBookings":0,"NumberOfCreatedBookings":0,"NumberOfCreatedCustomers":0,"OccuringBookingsByDay":[{"Value":0}],"CanceledBookingsByDay":[{"Value":0}],"CreatedBookingsByDay":[{"Value":0}],"CreatedCustomersByDay":[{"Value":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}