TicketUserServices

RefreshmentsOverviewRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Sales.Total

The following routes are available for this service:
POST	/sales/refreshments/overview

**RefreshmentsOverviewRequest** Parameters:
Name	Parameter	Data Type	Required
OwnerId	body	int	No
SeriesId	body	int?	No
FromUtc	body	DateTime	No
ToUtc	body	DateTime	No
CompareFromUtc	body	DateTime?	No
CompareToUtc	body	DateTime?	No
Bucket	body	string	No
TopEventsLimit	body	int	No
RecentOrdersLimit	body	int	No

**RefreshmentsOverviewResult** Parameters:
Name	Parameter	Data Type	Required
Current	form	RefreshmentsKpis	No
Previous	form	RefreshmentsKpis	No
Delta	form	RefreshmentsDeltas	No
Trend	form	List<SalesTrendBucket>	No
PreviousTrend	form	List<SalesTrendBucket>	No
Products	form	List<RefreshmentsProduct>	No
Events	form	List<RefreshmentsEventRow>	No
ByHourOfDay	form	List<SalesHourBucket>	No
ByDayOfWeek	form	List<SalesDowBucket>	No
ByPaymentMethod	form	List<RefreshmentsPaymentMethodRow>	No
RecentOrders	form	List<RefreshmentsRecentOrder>	No
HasAnyDataEver	form	bool	No
Bucket	form	string	No
FreshnessUtc	form	DateTime	No
StatusCode	form	int	No
Message	form	string	No

**RefreshmentsKpis** Parameters:
Name	Parameter	Data Type	Required
Revenue	form	decimal	No
Refunded	form	decimal	No
Units	form	int	No
Orders	form	int	No
Aov	form	decimal	No
UnitsPerOrder	form	decimal	No
Attendance	form	int	No
PerCap	form	decimal	No

**RefreshmentsDeltas** Parameters:
Name	Parameter	Data Type	Required
Revenue	form	KpiDelta	No
Refunded	form	KpiDelta	No
Units	form	KpiDelta	No
Orders	form	KpiDelta	No
Aov	form	KpiDelta	No
PerCap	form	KpiDelta	No

**KpiDelta** Parameters:
Name	Parameter	Data Type	Required
Abs	form	decimal	No
Pct	form	double?	No
Dir	form	string	No

**SalesTrendBucket** Parameters:
Name	Parameter	Data Type	Required
Bucket	form	DateTime	No
Revenue	form	decimal	No
Tickets	form	int	No

**RefreshmentsProduct** Parameters:
Name	Parameter	Data Type	Required
TicketTypeId	form	int	No
Name	form	string	No
Units	form	int	No
Revenue	form	decimal	No
Orders	form	int	No
LastSoldAt	form	DateTime?	No

**RefreshmentsEventRow** Parameters:
Name	Parameter	Data Type	Required
EventId	form	int	No
EventName	form	string	No
EventDate	form	DateTime?	No
Revenue	form	decimal	No
Units	form	int	No
Orders	form	int	No
Attendance	form	int	No
PerCap	form	decimal	No

**SalesHourBucket** Parameters:
Name	Parameter	Data Type	Required
Hour	form	int	No
Revenue	form	decimal	No
Orders	form	int	No
Tickets	form	int	No

**SalesDowBucket** Parameters:
Name	Parameter	Data Type	Required
Dow	form	int	No
Revenue	form	decimal	No
Orders	form	int	No
Tickets	form	int	No

**RefreshmentsPaymentMethodRow** Parameters:
Name	Parameter	Data Type	Required
PaymentMethodId	form	string	No
Revenue	form	decimal	No
Units	form	int	No
Orders	form	int	No

**RefreshmentsRecentOrder** Parameters:
Name	Parameter	Data Type	Required
TicketId	form	int	No
CreatedAt	form	DateTime	No
EventName	form	string	No
Amount	form	decimal	No
Units	form	int	No
PaymentMethodId	form	string	No

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.

POST /sales/refreshments/overview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	seriesId: 0,
	fromUtc: 0001-01-01,
	toUtc: 0001-01-01,
	compareFromUtc: 0001-01-01,
	compareToUtc: 0001-01-01,
	bucket: String,
	topEventsLimit: 0,
	recentOrdersLimit: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	current: 
	{
		revenue: 0,
		refunded: 0,
		units: 0,
		orders: 0,
		aov: 0,
		unitsPerOrder: 0,
		attendance: 0,
		perCap: 0
	},
	previous: 
	{
		revenue: 0,
		refunded: 0,
		units: 0,
		orders: 0,
		aov: 0,
		unitsPerOrder: 0,
		attendance: 0,
		perCap: 0
	},
	delta: 
	{
		revenue: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		refunded: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		units: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		orders: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		aov: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		perCap: 
		{
			abs: 0,
			pct: 0,
			dir: String
		}
	},
	trend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	previousTrend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	products: 
	[
		{
			ticketTypeId: 0,
			name: String,
			units: 0,
			revenue: 0,
			orders: 0,
			lastSoldAt: 0001-01-01
		}
	],
	events: 
	[
		{
			eventId: 0,
			eventName: String,
			eventDate: 0001-01-01,
			revenue: 0,
			units: 0,
			orders: 0,
			attendance: 0,
			perCap: 0
		}
	],
	byHourOfDay: 
	[
		{
			hour: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	byDayOfWeek: 
	[
		{
			dow: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	byPaymentMethod: 
	[
		{
			paymentMethodId: String,
			revenue: 0,
			units: 0,
			orders: 0
		}
	],
	recentOrders: 
	[
		{
			ticketId: 0,
			createdAt: 0001-01-01,
			eventName: String,
			amount: 0,
			units: 0,
			paymentMethodId: String
		}
	],
	hasAnyDataEver: False,
	bucket: String,
	freshnessUtc: 0001-01-01,
	statusCode: 0,
	message: String
}