TicketUserServices

<back to all web services

SalesOverviewRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Sales.Total
The following routes are available for this service:
POST/sales/overview

export class SalesKpis
{
    public grossNet?: number;
    public refunded?: number;
    public ticketsAllReal?: number;
    public ticketsPaid?: number;
    public orders?: number;
    public aov?: number;

    public constructor(init?: Partial<SalesKpis>) { (Object as any).assign(this, init); }
}

export class KpiDelta
{
    public abs?: number;
    public pct?: number;
    public dir?: string;

    public constructor(init?: Partial<KpiDelta>) { (Object as any).assign(this, init); }
}

export class SalesDeltas
{
    public grossNet?: KpiDelta;
    public refunded?: KpiDelta;
    public ticketsAllReal?: KpiDelta;
    public ticketsPaid?: KpiDelta;
    public orders?: KpiDelta;
    public aov?: KpiDelta;

    public constructor(init?: Partial<SalesDeltas>) { (Object as any).assign(this, init); }
}

export class SalesTrendBucket
{
    public bucket?: string;
    public revenue?: number;
    public tickets?: number;

    public constructor(init?: Partial<SalesTrendBucket>) { (Object as any).assign(this, init); }
}

export class SalesTopEvent
{
    public eventId?: number;
    public eventName?: string;
    public eventDate?: string;
    public grossNet?: number;
    public paidTickets?: number;
    public realTickets?: number;
    public orders?: number;

    public constructor(init?: Partial<SalesTopEvent>) { (Object as any).assign(this, init); }
}

export class SalesRecentOrder
{
    public ticketId?: number;
    public createdAt?: string;
    public eventName?: string;
    public amount?: number;
    public ticketCount?: number;
    public buyerName?: string;

    public constructor(init?: Partial<SalesRecentOrder>) { (Object as any).assign(this, init); }
}

export class SalesHourBucket
{
    public hour?: number;
    public revenue?: number;
    public orders?: number;
    public tickets?: number;

    public constructor(init?: Partial<SalesHourBucket>) { (Object as any).assign(this, init); }
}

export class SalesDowBucket
{
    public dow?: number;
    public revenue?: number;
    public orders?: number;
    public tickets?: number;

    public constructor(init?: Partial<SalesDowBucket>) { (Object as any).assign(this, init); }
}

export class SalesProduct
{
    public ticketName?: string;
    public tickets?: number;
    public revenue?: number;
    public orders?: number;

    public constructor(init?: Partial<SalesProduct>) { (Object as any).assign(this, init); }
}

export class SalesOverviewResult
{
    public current?: SalesKpis;
    public previous?: SalesKpis;
    public delta?: SalesDeltas;
    public trend?: SalesTrendBucket[];
    public previousTrend?: SalesTrendBucket[];
    public topEvents?: SalesTopEvent[];
    public recentOrders?: SalesRecentOrder[];
    public byHourOfDay?: SalesHourBucket[];
    public byDayOfWeek?: SalesDowBucket[];
    public topProducts?: SalesProduct[];
    public hasAnyDataEver?: boolean;
    public owners?: number[];
    public bucket?: string;
    public freshnessUtc?: string;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<SalesOverviewResult>) { (Object as any).assign(this, init); }
}

export class SalesOverviewRequest
{
    public eventOwnerId?: number;
    public additionalOwnerIds?: number[];
    public eventId?: number;
    public fromUtc?: string;
    public toUtc?: string;
    public compareFromUtc?: string;
    public compareToUtc?: string;
    public bucket?: string;
    public topEventsLimit?: number;
    public recentOrdersLimit?: number;

    public constructor(init?: Partial<SalesOverviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>