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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SalesOverviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AdditionalOwnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AdditionalOwnerIds>
  <Bucket>String</Bucket>
  <CompareFromUtc>0001-01-01T00:00:00</CompareFromUtc>
  <CompareToUtc>0001-01-01T00:00:00</CompareToUtc>
  <EventId>0</EventId>
  <EventOwnerId>0</EventOwnerId>
  <FromUtc>0001-01-01T00:00:00</FromUtc>
  <RecentOrdersLimit>0</RecentOrdersLimit>
  <ToUtc>0001-01-01T00:00:00</ToUtc>
  <TopEventsLimit>0</TopEventsLimit>
</SalesOverviewRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SalesOverviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Bucket>String</Bucket>
  <ByDayOfWeek>
    <SalesDowBucket>
      <Dow>0</Dow>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesDowBucket>
  </ByDayOfWeek>
  <ByHourOfDay>
    <SalesHourBucket>
      <Hour>0</Hour>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesHourBucket>
  </ByHourOfDay>
  <Current>
    <Aov>0</Aov>
    <GrossNet>0</GrossNet>
    <Orders>0</Orders>
    <Refunded>0</Refunded>
    <TicketsAllReal>0</TicketsAllReal>
    <TicketsPaid>0</TicketsPaid>
  </Current>
  <Delta>
    <Aov>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Aov>
    <GrossNet>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </GrossNet>
    <Orders>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Orders>
    <Refunded>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Refunded>
    <TicketsAllReal>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </TicketsAllReal>
    <TicketsPaid>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </TicketsPaid>
  </Delta>
  <FreshnessUtc>0001-01-01T00:00:00</FreshnessUtc>
  <HasAnyDataEver>false</HasAnyDataEver>
  <Message>String</Message>
  <Owners xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Owners>
  <Previous>
    <Aov>0</Aov>
    <GrossNet>0</GrossNet>
    <Orders>0</Orders>
    <Refunded>0</Refunded>
    <TicketsAllReal>0</TicketsAllReal>
    <TicketsPaid>0</TicketsPaid>
  </Previous>
  <PreviousTrend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </PreviousTrend>
  <RecentOrders>
    <SalesRecentOrder>
      <Amount>0</Amount>
      <BuyerName>String</BuyerName>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <EventName>String</EventName>
      <TicketCount>0</TicketCount>
      <TicketId>0</TicketId>
    </SalesRecentOrder>
  </RecentOrders>
  <StatusCode>0</StatusCode>
  <TopEvents>
    <SalesTopEvent>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <GrossNet>0</GrossNet>
      <Orders>0</Orders>
      <PaidTickets>0</PaidTickets>
      <RealTickets>0</RealTickets>
    </SalesTopEvent>
  </TopEvents>
  <TopProducts>
    <SalesProduct>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <TicketName>String</TicketName>
      <Tickets>0</Tickets>
    </SalesProduct>
  </TopProducts>
  <Trend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </Trend>
</SalesOverviewResult>