| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/overview |
|---|
namespace TicketUserServices.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SalesKpis() =
member val GrossNet:Decimal = new Decimal() with get,set
member val Refunded:Decimal = new Decimal() with get,set
member val TicketsAllReal:Int32 = new Int32() with get,set
member val TicketsPaid:Int32 = new Int32() with get,set
member val Orders:Int32 = new Int32() with get,set
member val Aov:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type KpiDelta() =
member val Abs:Decimal = new Decimal() with get,set
member val Pct:Nullable<Double> = new Nullable<Double>() with get,set
member val Dir:String = null with get,set
[<AllowNullLiteral>]
type SalesDeltas() =
member val GrossNet:KpiDelta = null with get,set
member val Refunded:KpiDelta = null with get,set
member val TicketsAllReal:KpiDelta = null with get,set
member val TicketsPaid:KpiDelta = null with get,set
member val Orders:KpiDelta = null with get,set
member val Aov:KpiDelta = null with get,set
[<AllowNullLiteral>]
type SalesTrendBucket() =
member val Bucket:DateTime = new DateTime() with get,set
member val Revenue:Decimal = new Decimal() with get,set
member val Tickets:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesTopEvent() =
member val EventId:Int32 = new Int32() with get,set
member val EventName:String = null with get,set
member val EventDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val GrossNet:Decimal = new Decimal() with get,set
member val PaidTickets:Int32 = new Int32() with get,set
member val RealTickets:Int32 = new Int32() with get,set
member val Orders:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesRecentOrder() =
member val TicketId:Int32 = new Int32() with get,set
member val CreatedAt:DateTime = new DateTime() with get,set
member val EventName:String = null with get,set
member val Amount:Decimal = new Decimal() with get,set
member val TicketCount:Int32 = new Int32() with get,set
member val BuyerName:String = null with get,set
[<AllowNullLiteral>]
type SalesHourBucket() =
member val Hour:Int32 = new Int32() with get,set
member val Revenue:Decimal = new Decimal() with get,set
member val Orders:Int32 = new Int32() with get,set
member val Tickets:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesDowBucket() =
member val Dow:Int32 = new Int32() with get,set
member val Revenue:Decimal = new Decimal() with get,set
member val Orders:Int32 = new Int32() with get,set
member val Tickets:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesProduct() =
member val TicketName:String = null with get,set
member val Tickets:Int32 = new Int32() with get,set
member val Revenue:Decimal = new Decimal() with get,set
member val Orders:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesOverviewResult() =
member val Current:SalesKpis = null with get,set
member val Previous:SalesKpis = null with get,set
member val Delta:SalesDeltas = null with get,set
member val Trend:ResizeArray<SalesTrendBucket> = new ResizeArray<SalesTrendBucket>() with get,set
member val PreviousTrend:ResizeArray<SalesTrendBucket> = new ResizeArray<SalesTrendBucket>() with get,set
member val TopEvents:ResizeArray<SalesTopEvent> = new ResizeArray<SalesTopEvent>() with get,set
member val RecentOrders:ResizeArray<SalesRecentOrder> = new ResizeArray<SalesRecentOrder>() with get,set
member val ByHourOfDay:ResizeArray<SalesHourBucket> = new ResizeArray<SalesHourBucket>() with get,set
member val ByDayOfWeek:ResizeArray<SalesDowBucket> = new ResizeArray<SalesDowBucket>() with get,set
member val TopProducts:ResizeArray<SalesProduct> = new ResizeArray<SalesProduct>() with get,set
member val HasAnyDataEver:Boolean = new Boolean() with get,set
member val Owners:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
member val Bucket:String = null with get,set
member val FreshnessUtc:DateTime = new DateTime() with get,set
member val StatusCode:Int32 = new Int32() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type SalesOverviewRequest() =
member val EventOwnerId:Int32 = new Int32() with get,set
member val AdditionalOwnerIds:Int32[] = [||] with get,set
member val EventId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val FromUtc:DateTime = new DateTime() with get,set
member val ToUtc:DateTime = new DateTime() with get,set
member val CompareFromUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CompareToUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Bucket:String = null with get,set
member val TopEventsLimit:Int32 = new Int32() with get,set
member val RecentOrdersLimit:Int32 = new Int32() with get,set
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.
POST /sales/overview HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"eventOwnerId":0,"additionalOwnerIds":[0],"eventId":0,"fromUtc":"0001-01-01T00:00:00.0000000","toUtc":"0001-01-01T00:00:00.0000000","compareFromUtc":"0001-01-01T00:00:00.0000000","compareToUtc":"0001-01-01T00:00:00.0000000","bucket":"String","topEventsLimit":0,"recentOrdersLimit":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","revenue":0,"tickets":0}],"previousTrend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"topEvents":[{"eventId":0,"eventName":"String","eventDate":"0001-01-01T00:00:00.0000000","grossNet":0,"paidTickets":0,"realTickets":0,"orders":0}],"recentOrders":[{"ticketId":0,"createdAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","statusCode":0,"message":"String"}