KPI Report API Get EOD summary by passing required parameter.
Key | Value |
---|---|
URL | https://api.ovvihq.com/KPIReport |
APIKey | Provided by OVVI |
StartDate | MM/dd/yyyy hh:mm tt" (Ex:-12/18/2019 12:00 AM) |
EndDate | MM/dd/yyyy hh:mm tt" (Ex:-12/20/2019 11:59 PM) |
- public string GetKPIReport()
- {
- get
- {
- string strResult = string.Empty;
- try
- {
- HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.ovvihq.com/KPIReport");
- request.ContentType = "application/json";
- request.Method = "GET";
- request.Headers.Add("APIKey", "Provided by OVVI");
- request.Headers.Add("StartDate", "01/01/2019 12:00 AM"); // MM/dd/yyyy hh:mm tt
- request.Headers.Add("EndDate", "01/02/2019 11:59 PM"); // MM/dd/yyyy hh:mm tt
- // Set some reasonable limits on resources used by this request
- request.ContentLength = 0;
- // Set credentials to use for this request.
- request.Credentials = CredentialCache.DefaultCredentials;
- HttpWebResponse response = (HttpWebResponse)request.GetResponse();
- // Get the stream associated with the response.
- Stream receiveStream = response.GetResponseStream();
- // Pipes the stream to a higher level stream reader with the required encoding format.
- StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
- strResult = readStream.ReadToEnd().ToString();
- response.Close();
- readStream.Close();
- return strResult;
- }
- catch (Exception ex)
- {
- strResult = Convert.ToString(ex.Message);
- return strResult;
- }
- }
- }
Key | Data Type | Description |
---|---|---|
StoreDetails | nvarchar(100) | Store Name based on APIKey. |
ClientID | nvarchar(10) | Client unique identification based on APIKey. |
DateValue | datetime | Date from passing Date range to get data. |
Trans_Count | int | Total transaction count. |
NetSales | money | Total sales amount without tax. |
TotalTax | money | Total sales tax amount. |
GrossSales | money | Total sales amount including tax. |
Check_Average | decimal(10,2) | Average sales per invoice. |
BreakFast | money | Total sales amount between breakfast timing. |
BreakFastPer | money | Total slaes percentage between Breakfast timing. |
Lunch | money | Total sales amount between Lunch timing. |
LYLunchamt | money | Last year sales amount(+/-) between Lunch timing. |
LYLunchPer | money | Last year sales percentage(+/-) between Lunch timing. |
LunchPer | money | Total sales percentage(+/-) between Lunch timing |
Dinner | money | Total sales amount(+/-) between Dinner timing. |
LYDinnerAmt | money | Last year sales amount(+/-) between Dinner timing. |
LYDinnerPer | money | Last year sales percentage(+/-) between Lunch timing. |
DinnerPer | money | Total sales percentage(+/-) between Dinner timing. |
LY_Sales | money | Last year total sales amount(+/-). |
LY_SalesPer | money | Last year total sales percentage(+/-). |
LY_Trans_Count | int | Last year total transaction count. |
Coupons | money | Total coupon discounted amount. |
Discounts | money | Total Invoice/Line discount amount. |
Refunds | money | Total refund amount after completing invoice payment. |
Mgr_Voids | money | Total amount of void transaction done by manager. |
Reg_Voids | money | Total amount of void transaction done by other employees. |
Crew_hours | decimal(10,2) | Total crew hours. |
CrewAmount | money | Total paid amount to crew(Amount is calculate according to crew total hours). |
Mgr_Hours | decimal(10,2) | Total manager hours. |
MgrAmount | money | Total paid amount to manager(Amount is calculate according to manager total hours). |
TTL_LaborPer | decimal(10,2) | Total labor percentage(labor percentage is total percentage of manager and other crew member). |
Sales_Per_Hours | decimal(10,2) | Hourly sales percentage. |
TotalLaborHour | decimal(10,2) | Total labor hours(labor total hours is total hours of manager and other employees/crew member). |
TotalLaborCost | money | Total paid cost to labor |
TotalPayout | money | Total amount of payout(payout include Vendor Payout,Credit To Customer etc..). |