Flipdish · Schema

AnalyticsClientEvent

Client Analytics event

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
EventName string The event name
EventType string Type of the event
AppType string Type of the app the event is coming from
Metadata string JSON Metadata
UserId integer User Id
Latitude number Latitude of the event
Longitude number Longitude of the event
FlipdishEventId string The identitfier of the event
CreateTime string The time of creation of the event
Position integer Position
AppId string App id
OrgId string Org id
IpAddress string Ip Address
ActivityId string Activity Id
ActivityType string Activity Type
View JSON Schema on GitHub

JSON Schema

platform-analytics-client-event-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/platform-analytics-client-event-schema.json",
  "title": "AnalyticsClientEvent",
  "description": "Client Analytics event",
  "type": "object",
  "properties": {
    "EventName": {
      "description": "The event name",
      "type": "string",
      "example": "Example Name"
    },
    "EventType": {
      "description": "Type of the event",
      "type": "string",
      "example": "string"
    },
    "AppType": {
      "description": "Type of the app the event is coming from",
      "type": "string",
      "example": "string"
    },
    "Metadata": {
      "description": "JSON Metadata",
      "type": "string",
      "example": "string"
    },
    "UserId": {
      "format": "int32",
      "description": "User Id",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "Latitude": {
      "format": "double",
      "description": "Latitude of the event",
      "type": "number",
      "nullable": true,
      "example": 1.0
    },
    "Longitude": {
      "format": "double",
      "description": "Longitude of the event",
      "type": "number",
      "nullable": true,
      "example": 1.0
    },
    "FlipdishEventId": {
      "format": "uuid",
      "description": "The identitfier of the event",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "CreateTime": {
      "format": "date-time",
      "description": "The time of creation of the event",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "Position": {
      "format": "int32",
      "description": "Position",
      "type": "integer",
      "example": 1
    },
    "AppId": {
      "description": "App id",
      "type": "string",
      "example": "500123"
    },
    "OrgId": {
      "description": "Org id",
      "type": "string",
      "example": "500123"
    },
    "IpAddress": {
      "description": "Ip Address",
      "type": "string",
      "example": "string"
    },
    "ActivityId": {
      "description": "Activity Id",
      "type": "string",
      "example": "500123"
    },
    "ActivityType": {
      "description": "Activity Type",
      "type": "string",
      "example": "string"
    }
  }
}