| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
"use strict";
export class SurvicateMetricsResponse {
/** @param {{StripePaidBookingsCount?:number,QvicklyPaidBookingsCount?:number,CodelockSyncedBookingsCount?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Number of distinct bookings paid via Stripe for the company. */
StripePaidBookingsCount;
/**
* @type {number}
* @description Number of distinct bookings paid via Qvickly for the company. */
QvicklyPaidBookingsCount;
/**
* @type {number}
* @description Approximate 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. */
CodelockSyncedBookingsCount;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class SurvicateMetricsQuery {
/** @param {{CompanyId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description Enter the company id. If blank and you are an admin, your own company id is used. */
CompanyId;
}
JavaScript SurvicateMetricsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: api.bookmore.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}