Flipdish · JSON Structure

Marketing Campaign Statistics Structure

Campaign statistics

Type: object Properties: 5
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

CampaignStatistics is a JSON Structure definition published by Flipdish, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

VouchersIssued VouchersRedeemed Conversion SalesGenerated ReturnOfInvestment

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

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