| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/overview |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
namespace TicketUserServices.ServiceModel
{
public partial class KpiDelta
{
public virtual decimal Abs { get; set; }
public virtual double? Pct { get; set; }
public virtual string Dir { get; set; }
}
public partial class SalesDeltas
{
public virtual KpiDelta GrossNet { get; set; }
public virtual KpiDelta Refunded { get; set; }
public virtual KpiDelta TicketsAllReal { get; set; }
public virtual KpiDelta TicketsPaid { get; set; }
public virtual KpiDelta Orders { get; set; }
public virtual KpiDelta Aov { get; set; }
}
public partial class SalesDowBucket
{
public virtual int Dow { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
public virtual int Tickets { get; set; }
}
public partial class SalesHourBucket
{
public virtual int Hour { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
public virtual int Tickets { get; set; }
}
public partial class SalesKpis
{
public virtual decimal GrossNet { get; set; }
public virtual decimal Refunded { get; set; }
public virtual int TicketsAllReal { get; set; }
public virtual int TicketsPaid { get; set; }
public virtual int Orders { get; set; }
public virtual decimal Aov { get; set; }
}
public partial class SalesOverviewRequest
{
public SalesOverviewRequest()
{
AdditionalOwnerIds = new int[]{};
}
public virtual int EventOwnerId { get; set; }
public virtual int[] AdditionalOwnerIds { get; set; }
public virtual int? EventId { get; set; }
public virtual DateTime FromUtc { get; set; }
public virtual DateTime ToUtc { get; set; }
public virtual DateTime? CompareFromUtc { get; set; }
public virtual DateTime? CompareToUtc { get; set; }
public virtual string Bucket { get; set; }
public virtual int TopEventsLimit { get; set; }
public virtual int RecentOrdersLimit { get; set; }
}
public partial class SalesOverviewResult
{
public SalesOverviewResult()
{
Trend = new List<SalesTrendBucket>{};
PreviousTrend = new List<SalesTrendBucket>{};
TopEvents = new List<SalesTopEvent>{};
RecentOrders = new List<SalesRecentOrder>{};
ByHourOfDay = new List<SalesHourBucket>{};
ByDayOfWeek = new List<SalesDowBucket>{};
TopProducts = new List<SalesProduct>{};
Owners = new List<int>{};
}
public virtual SalesKpis Current { get; set; }
public virtual SalesKpis Previous { get; set; }
public virtual SalesDeltas Delta { get; set; }
public virtual List<SalesTrendBucket> Trend { get; set; }
public virtual List<SalesTrendBucket> PreviousTrend { get; set; }
public virtual List<SalesTopEvent> TopEvents { get; set; }
public virtual List<SalesRecentOrder> RecentOrders { get; set; }
public virtual List<SalesHourBucket> ByHourOfDay { get; set; }
public virtual List<SalesDowBucket> ByDayOfWeek { get; set; }
public virtual List<SalesProduct> TopProducts { get; set; }
public virtual bool HasAnyDataEver { get; set; }
public virtual List<int> Owners { get; set; }
public virtual string Bucket { get; set; }
public virtual DateTime FreshnessUtc { get; set; }
public virtual int StatusCode { get; set; }
public virtual string Message { get; set; }
}
public partial class SalesProduct
{
public virtual string TicketName { get; set; }
public virtual int Tickets { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
}
public partial class SalesRecentOrder
{
public virtual int TicketId { get; set; }
public virtual DateTime CreatedAt { get; set; }
public virtual string EventName { get; set; }
public virtual decimal Amount { get; set; }
public virtual int TicketCount { get; set; }
public virtual string BuyerName { get; set; }
}
public partial class SalesTopEvent
{
public virtual int EventId { get; set; }
public virtual string EventName { get; set; }
public virtual DateTime? EventDate { get; set; }
public virtual decimal GrossNet { get; set; }
public virtual int PaidTickets { get; set; }
public virtual int RealTickets { get; set; }
public virtual int Orders { get; set; }
}
public partial class SalesTrendBucket
{
public virtual DateTime Bucket { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Tickets { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
eventOwnerId: 0,
additionalOwnerIds:
[
0
],
eventId: 0,
fromUtc: 0001-01-01,
toUtc: 0001-01-01,
compareFromUtc: 0001-01-01,
compareToUtc: 0001-01-01,
bucket: String,
topEventsLimit: 0,
recentOrdersLimit: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
revenue: 0,
tickets: 0
}
],
previousTrend:
[
{
bucket: 0001-01-01,
revenue: 0,
tickets: 0
}
],
topEvents:
[
{
eventId: 0,
eventName: String,
eventDate: 0001-01-01,
grossNet: 0,
paidTickets: 0,
realTickets: 0,
orders: 0
}
],
recentOrders:
[
{
ticketId: 0,
createdAt: 0001-01-01,
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-01,
statusCode: 0,
message: String
}