| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /survicate/metrics |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
public class SurvicateMetricsQuery : ICompany, Codable
{
/**
* Enter the company id. If blank and you are an admin, your own company id is used.
*/
// @ApiMember(Description="Enter the company id. If blank and you are an admin, your own company id is used.", ParameterType="query")
public var companyId:String?
required public init(){}
}
public class SurvicateMetricsResponse : Codable
{
/**
* Number of distinct bookings paid via Stripe for the company.
*/
// @ApiMember(Description="Number of distinct bookings paid via Stripe for the company.")
public var stripePaidBookingsCount:Int
/**
* Number of distinct bookings paid via Qvickly for the company.
*/
// @ApiMember(Description="Number of distinct bookings paid via Qvickly for the company.")
public var qvicklyPaidBookingsCount:Int
/**
* 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.
*/
// @ApiMember(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.")
public var codelockSyncedBookingsCount:Int
public var responseStatus:ResponseStatus
required public init(){}
}
Swift SurvicateMetricsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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: api.bookmore.com 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"}}}