Created
February 2, 2022 13:13
-
-
Save manashmandal/5460ba39f9eae596314960553309ed84 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.3", | |
"info": { | |
"title": "Bmi Screen Event", | |
"description": "All of events will be there which one is trigger on Bmi Screen ui", | |
"version": "1.0.0" | |
}, | |
"paths": {}, | |
"tags": [{ | |
"name": "Event Details" | |
}], | |
"components": { | |
"schemas": { | |
"screen_view": { | |
"type": "object", | |
"required": ["screen", "category", "is_logged_in", "device_id", "version_name", "version_code"], | |
"properties": { | |
"screen": { | |
"type": "string", | |
"enum": ["bmi_screen"], | |
"description": "Screen name of where the event was triggered" | |
}, | |
"category": { | |
"type": "string", | |
"description": "Category name of that event provided from app" | |
}, | |
"event_name": { | |
"type": "string", | |
"enum": ["screen_view"], | |
"description": "Name of event of which is trigger from app" | |
}, | |
"user_id": { | |
"type": "string", | |
"description": "Unique identifier of a user" | |
}, | |
"is_premium": { | |
"type": "boolean", | |
"description": "If the user is and premium user then it will be true otherwise false" | |
}, | |
"is_logged_in": { | |
"type": "boolean", | |
"description": "Whatever user is logged user or guest user. if logged user then it will be true otherwise false" | |
}, | |
"user_region": { | |
"type": "string", | |
"description": "Short form of user country like bd, pk, in etc" | |
}, | |
"user_ip": { | |
"type": "string", | |
"description": "Client IP address of a user." | |
}, | |
"device_id": { | |
"type": "string", | |
"description": "Unique device identification of a user" | |
}, | |
"version_name": { | |
"type": "string", | |
"description": "Installed app version name" | |
}, | |
"version_code": { | |
"type": "string", | |
"description": "Installed app version code" | |
}, | |
"device_model": { | |
"type": "string", | |
"description": "Model of that device user from uses" | |
}, | |
"os_version": { | |
"type": "string", | |
"description": "Operating system running version" | |
}, | |
"os_platform": { | |
"type": "string", | |
"description": "Platform of the device whatever android or iOS" | |
}, | |
"device_manufacturer": { | |
"type": "string", | |
"description": "Manufacturer company of who produced the device" | |
}, | |
"device_product": { | |
"type": "string", | |
"description": "Product name of the device" | |
}, | |
"device_brand": { | |
"type": "string", | |
"description": "Brand name of the device" | |
}, | |
"device_sku": { | |
"type": "string", | |
"description": "Device sku name of the device" | |
}, | |
"network": { | |
"type": "string", | |
"description": "Which network is user connected, mobile data or wifi" | |
}, | |
"installation_id": { | |
"type": "string", | |
"description": "Firebase installation id unique identification of onetime installed on that device" | |
}, | |
"event_date": { | |
"type": "string", | |
"format": "date", | |
"description": "Date of event" | |
}, | |
"event_timestamp": { | |
"type": "string", | |
"description": "Date of timestamp" | |
}, | |
"utm_source": { | |
"type": "string", | |
"description": "Campaign source" | |
}, | |
"utm_medium": { | |
"type": "string", | |
"description": "Campaign medium" | |
}, | |
"utm_campaign": { | |
"type": "string", | |
"description": "Campaign name" | |
}, | |
"utm_term": { | |
"type": "string", | |
"description": "Campaign term" | |
}, | |
"utm_content": { | |
"type": "string", | |
"description": "Campaign content" | |
}, | |
"created_at": { | |
"type": "string", | |
"format": "date-time" | |
} | |
} | |
}, | |
"bmi_submit": { | |
"type": "object", | |
"required": ["screen", "category", "is_logged_in", "device_id", "version_name", "version_code", "bmi_score"], | |
"properties": { | |
"screen": { | |
"type": "string", | |
"enum": ["bmi_screen"], | |
"description": "Screen name of where the event was triggered" | |
}, | |
"category": { | |
"type": "string", | |
"description": "Category name of that event provided from app" | |
}, | |
"event_name": { | |
"type": "string", | |
"enum": ["bmi_submit"], | |
"description": "Name of event of which is trigger from app" | |
}, | |
"user_id": { | |
"type": "string", | |
"description": "Unique identifier of a user" | |
}, | |
"is_premium": { | |
"type": "boolean", | |
"description": "If the user is and premium user then it will be true otherwise false" | |
}, | |
"is_logged_in": { | |
"type": "boolean", | |
"description": "Whatever user is logged user or guest user. if logged user then it will be true otherwise false" | |
}, | |
"user_region": { | |
"type": "string", | |
"description": "Short form of user country like bd, pk, in etc" | |
}, | |
"user_ip": { | |
"type": "string", | |
"description": "Client IP address of a user." | |
}, | |
"device_id": { | |
"type": "string", | |
"description": "Unique device identification of a user" | |
}, | |
"version_name": { | |
"type": "string", | |
"description": "Installed app version name" | |
}, | |
"version_code": { | |
"type": "string", | |
"description": "Installed app version code" | |
}, | |
"device_model": { | |
"type": "string", | |
"description": "Model of that device user from uses" | |
}, | |
"os_version": { | |
"type": "string", | |
"description": "Operating system running version" | |
}, | |
"os_platform": { | |
"type": "string", | |
"description": "Platform of the device whatever android or iOS" | |
}, | |
"device_manufacturer": { | |
"type": "string", | |
"description": "Manufacturer company of who produced the device" | |
}, | |
"device_product": { | |
"type": "string", | |
"description": "Product name of the device" | |
}, | |
"device_brand": { | |
"type": "string", | |
"description": "Brand name of the device" | |
}, | |
"device_sku": { | |
"type": "string", | |
"description": "Device sku name of the device" | |
}, | |
"network": { | |
"type": "string", | |
"description": "Which network is user connected, mobile data or wifi" | |
}, | |
"installation_id": { | |
"type": "string", | |
"description": "Firebase installation id unique identification of onetime installed on that device" | |
}, | |
"event_date": { | |
"type": "string", | |
"format": "date", | |
"description": "Date of event" | |
}, | |
"event_timestamp": { | |
"type": "string", | |
"description": "Date of timestamp" | |
}, | |
"utm_source": { | |
"type": "string", | |
"description": "Campaign source" | |
}, | |
"utm_medium": { | |
"type": "string", | |
"description": "Campaign medium" | |
}, | |
"utm_campaign": { | |
"type": "string", | |
"description": "Campaign name" | |
}, | |
"utm_term": { | |
"type": "string", | |
"description": "Campaign term" | |
}, | |
"utm_content": { | |
"type": "string", | |
"description": "Campaign content" | |
}, | |
"created_at": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"bmi_score": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment