Flipdish · Schema

CampaignStatistics

Campaign statistics

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
VouchersIssued integer Deprecated. Number of issued vouchers. This field is always zero.
VouchersRedeemed integer Deprecated. Number of redeemed vouchers. This field is always zero. This field is always zero.
Conversion number Deprecated. Conversion of campaign (VouchersIssued / VouchersRedeemed). This field is always zero.
SalesGenerated number Deprecated. Sales generated by campaign (TotalAmount - FeeChargedToCustomer ie. the discounted sale value). This field is always zero.
ReturnOfInvestment number Deprecated. Return of investment of campaign (TotalAmount / DiscountAmount). This field is always zero.
View JSON Schema on GitHub

JSON Schema

marketing-campaign-statistics-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/marketing-campaign-statistics-schema.json",
  "title": "CampaignStatistics",
  "description": "Campaign statistics",
  "type": "object",
  "properties": {
    "VouchersIssued": {
      "format": "int32",
      "description": "Deprecated. Number of issued vouchers.\r\nThis field is always zero.",
      "type": "integer",
      "example": 1
    },
    "VouchersRedeemed": {
      "format": "int32",
      "description": "Deprecated. Number of redeemed vouchers. This field is always zero.\r\nThis field is always zero.",
      "type": "integer",
      "example": 1
    },
    "Conversion": {
      "format": "double",
      "description": "Deprecated. Conversion of campaign (VouchersIssued / VouchersRedeemed).\r\nThis field is always zero.",
      "type": "number",
      "example": 1.0
    },
    "SalesGenerated": {
      "format": "double",
      "description": "Deprecated.\r\nSales generated by campaign (TotalAmount - FeeChargedToCustomer ie. the discounted sale value).\r\nThis field is always zero.",
      "type": "number",
      "example": 1.0
    },
    "ReturnOfInvestment": {
      "format": "double",
      "description": "Deprecated.\r\nReturn of investment of campaign (TotalAmount / DiscountAmount).\r\nThis field is always zero.",
      "type": "number",
      "example": 1.0
    }
  }
}