BokaMera.API.Host

<back to all web services

SurvicateMetricsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/survicate/metrics
SurvicateMetricsQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company id. If blank and you are an admin, your own company id is used.
SurvicateMetricsResponse Parameters:
NameParameterData TypeRequiredDescription
StripePaidBookingsCountformintNoNumber of distinct bookings paid via Stripe for the company.
QvicklyPaidBookingsCountformintNoNumber of distinct bookings paid via Qvickly for the company.
CodelockSyncedBookingsCountformintNoApproximate number of bookings synced to a code lock / access control system. Derived from access-control external references (CodeLockAccessKey, IloqBookingKey); the system does not record confirmed syncs, so treat this as a proxy, not an exact count.
ResponseStatusformResponseStatusYes

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

HTTP + CSV

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

GET /survicate/metrics HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"StripePaidBookingsCount":0,"QvicklyPaidBookingsCount":0,"CodelockSyncedBookingsCount":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}