| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/overview |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesKpis:
gross_net: Optional[Decimal] = None
refunded: Optional[Decimal] = None
tickets_all_real: Optional[int] = None
tickets_paid: Optional[int] = None
orders: Optional[int] = None
aov: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class KpiDelta:
abs: Optional[Decimal] = None
pct: Optional[float] = None
dir: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesDeltas:
gross_net: Optional[KpiDelta] = None
refunded: Optional[KpiDelta] = None
tickets_all_real: Optional[KpiDelta] = None
tickets_paid: Optional[KpiDelta] = None
orders: Optional[KpiDelta] = None
aov: Optional[KpiDelta] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesTrendBucket:
bucket: Optional[datetime.datetime] = None
revenue: Optional[Decimal] = None
tickets: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesTopEvent:
event_id: Optional[int] = None
event_name: Optional[str] = None
event_date: Optional[datetime.datetime] = None
gross_net: Optional[Decimal] = None
paid_tickets: Optional[int] = None
real_tickets: Optional[int] = None
orders: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesRecentOrder:
ticket_id: Optional[int] = None
created_at: Optional[datetime.datetime] = None
event_name: Optional[str] = None
amount: Optional[Decimal] = None
ticket_count: Optional[int] = None
buyer_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesHourBucket:
hour: Optional[int] = None
revenue: Optional[Decimal] = None
orders: Optional[int] = None
tickets: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesDowBucket:
dow: Optional[int] = None
revenue: Optional[Decimal] = None
orders: Optional[int] = None
tickets: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesProduct:
ticket_name: Optional[str] = None
tickets: Optional[int] = None
revenue: Optional[Decimal] = None
orders: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesOverviewResult:
current: Optional[SalesKpis] = None
previous: Optional[SalesKpis] = None
delta: Optional[SalesDeltas] = None
trend: Optional[List[SalesTrendBucket]] = None
previous_trend: Optional[List[SalesTrendBucket]] = None
top_events: Optional[List[SalesTopEvent]] = None
recent_orders: Optional[List[SalesRecentOrder]] = None
by_hour_of_day: Optional[List[SalesHourBucket]] = None
by_day_of_week: Optional[List[SalesDowBucket]] = None
top_products: Optional[List[SalesProduct]] = None
has_any_data_ever: Optional[bool] = None
owners: Optional[List[int]] = None
bucket: Optional[str] = None
freshness_utc: Optional[datetime.datetime] = None
status_code: Optional[int] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesOverviewRequest:
event_owner_id: Optional[int] = None
additional_owner_ids: Optional[List[int]] = None
event_id: Optional[int] = None
from_utc: Optional[datetime.datetime] = None
to_utc: Optional[datetime.datetime] = None
compare_from_utc: Optional[datetime.datetime] = None
compare_to_utc: Optional[datetime.datetime] = None
bucket: Optional[str] = None
top_events_limit: Optional[int] = None
recent_orders_limit: Optional[int] = None
Python SalesOverviewRequest DTOs
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
}