TicketUserServices

SalesOverviewRequest

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

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

**SalesOverviewRequest** Parameters:
Name	Parameter	Data Type	Required
EventOwnerId	body	int	No
AdditionalOwnerIds	body	int[]	No
EventId	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

**SalesOverviewResult** Parameters:
Name	Parameter	Data Type	Required
Current	form	SalesKpis	No
Previous	form	SalesKpis	No
Delta	form	SalesDeltas	No
Trend	form	List<SalesTrendBucket>	No
PreviousTrend	form	List<SalesTrendBucket>	No
TopEvents	form	List<SalesTopEvent>	No
RecentOrders	form	List<SalesRecentOrder>	No
ByHourOfDay	form	List<SalesHourBucket>	No
ByDayOfWeek	form	List<SalesDowBucket>	No
TopProducts	form	List<SalesProduct>	No
HasAnyDataEver	form	bool	No
Owners	form	List<int>	No
Bucket	form	string	No
FreshnessUtc	form	DateTime	No
StatusCode	form	int	No
Message	form	string	No

**SalesKpis** Parameters:
Name	Parameter	Data Type	Required
GrossNet	form	decimal	No
Refunded	form	decimal	No
TicketsAllReal	form	int	No
TicketsPaid	form	int	No
Orders	form	int	No
Aov	form	decimal	No

**SalesDeltas** Parameters:
Name	Parameter	Data Type	Required
GrossNet	form	KpiDelta	No
Refunded	form	KpiDelta	No
TicketsAllReal	form	KpiDelta	No
TicketsPaid	form	KpiDelta	No
Orders	form	KpiDelta	No
Aov	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

**SalesTopEvent** Parameters:
Name	Parameter	Data Type	Required
EventId	form	int	No
EventName	form	string	No
EventDate	form	DateTime?	No
GrossNet	form	decimal	No
PaidTickets	form	int	No
RealTickets	form	int	No
Orders	form	int	No

**SalesRecentOrder** Parameters:
Name	Parameter	Data Type	Required
TicketId	form	int	No
CreatedAt	form	DateTime	No
EventName	form	string	No
Amount	form	decimal	No
TicketCount	form	int	No
BuyerName	form	string	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

**SalesProduct** Parameters:
Name	Parameter	Data Type	Required
TicketName	form	string	No
Tickets	form	int	No
Revenue	form	decimal	No
Orders	form	int	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/overview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	eventOwnerId: 0,
	additionalOwnerIds: 
	[
		0
	],
	eventId: 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: 
	{
		grossNet: 0,
		refunded: 0,
		ticketsAllReal: 0,
		ticketsPaid: 0,
		orders: 0,
		aov: 0
	},
	previous: 
	{
		grossNet: 0,
		refunded: 0,
		ticketsAllReal: 0,
		ticketsPaid: 0,
		orders: 0,
		aov: 0
	},
	delta: 
	{
		grossNet: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		refunded: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		ticketsAllReal: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		ticketsPaid: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		orders: 
		{
			abs: 0,
			pct: 0,
			dir: String
		},
		aov: 
		{
			abs: 0,
			pct: 0,
			dir: String
		}
	},
	trend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	previousTrend: 
	[
		{
			bucket: 0001-01-01,
			revenue: 0,
			tickets: 0
		}
	],
	topEvents: 
	[
		{
			eventId: 0,
			eventName: String,
			eventDate: 0001-01-01,
			grossNet: 0,
			paidTickets: 0,
			realTickets: 0,
			orders: 0
		}
	],
	recentOrders: 
	[
		{
			ticketId: 0,
			createdAt: 0001-01-01,
			eventName: String,
			amount: 0,
			ticketCount: 0,
			buyerName: String
		}
	],
	byHourOfDay: 
	[
		{
			hour: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	byDayOfWeek: 
	[
		{
			dow: 0,
			revenue: 0,
			orders: 0,
			tickets: 0
		}
	],
	topProducts: 
	[
		{
			ticketName: String,
			tickets: 0,
			revenue: 0,
			orders: 0
		}
	],
	hasAnyDataEver: False,
	owners: 
	[
		0
	],
	bucket: String,
	freshnessUtc: 0001-01-01,
	statusCode: 0,
	message: String
}