Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /statistics |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | Yes | Enter the company id, if blank company id and you are an admin, your company id will be used. |
From | query | DateTime | Yes | Start of interval to get bookings and customers |
To | query | DateTime | Yes | End of interval to get bookings and customers |
IncludeOccuringBookingsByDay | query | bool | No | Set true if you want to include booked events by day |
IncludeBookingsCanceledByDay | query | bool | No | Set true if you want to include canceled booked events by day |
IncludeCreatedBookingsByDay | query | bool | No | Set true if you want to include booking created by day |
IncludeCreatedCustomersByDay | query | bool | No | Set true if you want to include customers created by day |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NumberOfOccuringBookings | form | int | No | |
NumberOfCanceledBookings | form | int | No | |
NumberOfCreatedBookings | form | int | No | |
NumberOfCreatedCustomers | form | int | No | |
OccuringBookingsByDay | form | List<BookedByDay> | No | |
CanceledBookingsByDay | form | List<BookedByDay> | No | |
CreatedBookingsByDay | form | List<BookedByDay> | No | |
CreatedCustomersByDay | form | List<BookedByDay> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Date | form | DateTime | No | |
Value | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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 } } }