KPI Report API Get EOD summary by passing required parameter.

GET /KPIReport
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)
                                
  1. public string GetKPIReport()
  2. {
  3. get
  4. {
  5. string strResult = string.Empty;
  6. try
  7. {
  8. HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.ovvihq.com/KPIReport");
  9. request.ContentType = "application/json";
  10. request.Method = "GET";
  11. request.Headers.Add("APIKey", "Provided by OVVI");
  12. request.Headers.Add("StartDate", "01/01/2019 12:00 AM"); // MM/dd/yyyy hh:mm tt
  13. request.Headers.Add("EndDate", "01/02/2019 11:59 PM"); // MM/dd/yyyy hh:mm tt
  14. // Set some reasonable limits on resources used by this request
  15. request.ContentLength = 0;
  16. // Set credentials to use for this request.
  17. request.Credentials = CredentialCache.DefaultCredentials;
  18. HttpWebResponse response = (HttpWebResponse)request.GetResponse();
  19. // Get the stream associated with the response.
  20. Stream receiveStream = response.GetResponseStream();
  21. // Pipes the stream to a higher level stream reader with the required encoding format.
  22. StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
  23. strResult = readStream.ReadToEnd().ToString();
  24. response.Close();
  25. readStream.Close();
  26. return strResult;
  27. }
  28. catch (Exception ex)
  29. {
  30. strResult = Convert.ToString(ex.Message);
  31. return strResult;
  32. }
  33. }
  34. }
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..).