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

import Foundation
import ServiceStack

public class SalesOverviewRequest : Codable
{
    public var eventOwnerId:Int?
    public var additionalOwnerIds:[Int] = []
    public var eventId:Int?
    public var fromUtc:Date?
    public var toUtc:Date?
    public var compareFromUtc:Date?
    public var compareToUtc:Date?
    public var bucket:String?
    public var topEventsLimit:Int?
    public var recentOrdersLimit:Int?

    required public init(){}
}

public class SalesOverviewResult : Codable
{
    public var current:SalesKpis?
    public var previous:SalesKpis?
    public var delta:SalesDeltas?
    public var trend:[SalesTrendBucket] = []
    public var previousTrend:[SalesTrendBucket] = []
    public var topEvents:[SalesTopEvent] = []
    public var recentOrders:[SalesRecentOrder] = []
    public var byHourOfDay:[SalesHourBucket] = []
    public var byDayOfWeek:[SalesDowBucket] = []
    public var topProducts:[SalesProduct] = []
    public var hasAnyDataEver:Bool?
    public var owners:[Int] = []
    public var bucket:String?
    public var freshnessUtc:Date?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class SalesKpis : Codable
{
    public var grossNet:Double?
    public var refunded:Double?
    public var ticketsAllReal:Int?
    public var ticketsPaid:Int?
    public var orders:Int?
    public var aov:Double?

    required public init(){}
}

public class SalesDeltas : Codable
{
    public var grossNet:KpiDelta?
    public var refunded:KpiDelta?
    public var ticketsAllReal:KpiDelta?
    public var ticketsPaid:KpiDelta?
    public var orders:KpiDelta?
    public var aov:KpiDelta?

    required public init(){}
}

public class KpiDelta : Codable
{
    public var abs:Double?
    public var pct:Double?
    public var dir:String?

    required public init(){}
}

public class SalesTrendBucket : Codable
{
    public var bucket:Date?
    public var revenue:Double?
    public var tickets:Int?

    required public init(){}
}

public class SalesTopEvent : Codable
{
    public var eventId:Int?
    public var eventName:String?
    public var eventDate:Date?
    public var grossNet:Double?
    public var paidTickets:Int?
    public var realTickets:Int?
    public var orders:Int?

    required public init(){}
}

public class SalesRecentOrder : Codable
{
    public var ticketId:Int?
    public var createdAt:Date?
    public var eventName:String?
    public var amount:Double?
    public var ticketCount:Int?
    public var buyerName:String?

    required public init(){}
}

public class SalesHourBucket : Codable
{
    public var hour:Int?
    public var revenue:Double?
    public var orders:Int?
    public var tickets:Int?

    required public init(){}
}

public class SalesDowBucket : Codable
{
    public var dow:Int?
    public var revenue:Double?
    public var orders:Int?
    public var tickets:Int?

    required public init(){}
}

public class SalesProduct : Codable
{
    public var ticketName:String?
    public var tickets:Int?
    public var revenue:Double?
    public var orders:Int?

    required public init(){}
}

Swift SalesOverviewRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}