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 java.math.*
import java.util.*
import net.servicestack.client.*


open class SalesOverviewRequest
{
    var eventOwnerId:Int? = null
    var additionalOwnerIds:ArrayList<Int>? = null
    var eventId:Int? = null
    var fromUtc:Date? = null
    var toUtc:Date? = null
    var compareFromUtc:Date? = null
    var compareToUtc:Date? = null
    var bucket:String? = null
    var topEventsLimit:Int? = null
    var recentOrdersLimit:Int? = null
}

open class SalesOverviewResult
{
    var current:SalesKpis? = null
    var previous:SalesKpis? = null
    var delta:SalesDeltas? = null
    var trend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var previousTrend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var topEvents:ArrayList<SalesTopEvent> = ArrayList<SalesTopEvent>()
    var recentOrders:ArrayList<SalesRecentOrder> = ArrayList<SalesRecentOrder>()
    var byHourOfDay:ArrayList<SalesHourBucket> = ArrayList<SalesHourBucket>()
    var byDayOfWeek:ArrayList<SalesDowBucket> = ArrayList<SalesDowBucket>()
    var topProducts:ArrayList<SalesProduct> = ArrayList<SalesProduct>()
    var hasAnyDataEver:Boolean? = null
    var owners:ArrayList<Int> = ArrayList<Int>()
    var bucket:String? = null
    var freshnessUtc:Date? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class SalesKpis
{
    var grossNet:BigDecimal? = null
    var refunded:BigDecimal? = null
    var ticketsAllReal:Int? = null
    var ticketsPaid:Int? = null
    var orders:Int? = null
    var aov:BigDecimal? = null
}

open class SalesDeltas
{
    var grossNet:KpiDelta? = null
    var refunded:KpiDelta? = null
    var ticketsAllReal:KpiDelta? = null
    var ticketsPaid:KpiDelta? = null
    var orders:KpiDelta? = null
    var aov:KpiDelta? = null
}

open class KpiDelta
{
    var abs:BigDecimal? = null
    var pct:Double? = null
    var dir:String? = null
}

open class SalesTrendBucket
{
    var bucket:Date? = null
    var revenue:BigDecimal? = null
    var tickets:Int? = null
}

open class SalesTopEvent
{
    var eventId:Int? = null
    var eventName:String? = null
    var eventDate:Date? = null
    var grossNet:BigDecimal? = null
    var paidTickets:Int? = null
    var realTickets:Int? = null
    var orders:Int? = null
}

open class SalesRecentOrder
{
    var ticketId:Int? = null
    var createdAt:Date? = null
    var eventName:String? = null
    var amount:BigDecimal? = null
    var ticketCount:Int? = null
    var buyerName:String? = null
}

open class SalesHourBucket
{
    var hour:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class SalesDowBucket
{
    var dow:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class SalesProduct
{
    var ticketName:String? = null
    var tickets:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
}

Kotlin SalesOverviewRequest DTOs

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

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