BokaMera.API.Host

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

"use strict";
export class BookedByDay {
    /** @param {{Date?:string,Value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {number} */
    Value;
}
export class StatisticQueryResponse {
    /** @param {{NumberOfOccuringBookings?:number,NumberOfCanceledBookings?:number,NumberOfCreatedBookings?:number,NumberOfCreatedCustomers?:number,OccuringBookingsByDay?:BookedByDay[],CanceledBookingsByDay?:BookedByDay[],CreatedBookingsByDay?:BookedByDay[],CreatedCustomersByDay?:BookedByDay[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NumberOfOccuringBookings;
    /** @type {number} */
    NumberOfCanceledBookings;
    /** @type {number} */
    NumberOfCreatedBookings;
    /** @type {number} */
    NumberOfCreatedCustomers;
    /** @type {BookedByDay[]} */
    OccuringBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CanceledBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CreatedBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CreatedCustomersByDay = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class StatisticQuery {
    /** @param {{CompanyId?:string,From?:string,To?:string,IncludeOccuringBookingsByDay?:boolean,IncludeBookingsCanceledByDay?:boolean,IncludeCreatedBookingsByDay?:boolean,IncludeCreatedCustomersByDay?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter the company id, if blank company id and you are an admin, your company id will be used. */
    CompanyId;
    /**
     * @type {string}
     * @description Start of interval to get bookings and customers */
    From;
    /**
     * @type {string}
     * @description End of interval to get bookings and customers */
    To;
    /**
     * @type {boolean}
     * @description Set true if you want to include booked events by day */
    IncludeOccuringBookingsByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include canceled booked events by day */
    IncludeBookingsCanceledByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include booking created by day */
    IncludeCreatedBookingsByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include customers created by day */
    IncludeCreatedCustomersByDay;
}

JavaScript StatisticQuery DTOs

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

HTTP + 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
		}
	}
}