Flipdish · JSON Structure

Platform Analytics Client Event Structure

Client Analytics event

Type: object Properties: 15

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

EventName EventType AppType Metadata UserId Latitude Longitude FlipdishEventId CreateTime Position AppId OrgId IpAddress ActivityId ActivityType

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/platform-analytics-client-event-structure.json",
  "name": "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": {
      "description": "User Id",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "Latitude": {
      "description": "Latitude of the event",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "Longitude": {
      "description": "Longitude of the event",
      "type": "double",
      "nullable": true,
      "example": 1.0
    },
    "FlipdishEventId": {
      "description": "The identitfier of the event",
      "type": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "CreateTime": {
      "description": "The time of creation of the event",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "Position": {
      "description": "Position",
      "type": "int32",
      "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"
    }
  }
}