add event example desc

app/(swagger)/swagger/page.tsx

@@ -526,203 +526,203 @@ export default function SwaggerPage() {
             event_id: {
               type: 'string',
               format: 'uuid',
-              description: 'Unique identifier for the event (auto-generated if not provided)'
+              description: '事件唯一标识符，用于唯一标识事件记录。若不提供则自动生成UUID'
             },
             event_time: {
               type: 'string',
               format: 'date-time',
-              description: 'Time when the event occurred (defaults to current time if not provided)'
+              description: '事件发生的时间戳（ISO 8601格式），记录事件发生的精确时间。若不提供则使用当前服务器时间'
             },
             event_type: {
               type: 'string',
               enum: ['click', 'conversion', 'redirect', 'error'],
-              description: 'Type of the event'
+              description: '事件类型，用于分类不同的用户交互行为。click表示点击事件，conversion表示转化事件，redirect表示重定向事件，error表示错误事件'
             },
             event_attributes: {
               type: 'string',
-              description: 'JSON string with additional event attributes'
+              description: '事件附加属性的JSON字符串，用于存储与特定事件相关的自定义数据，例如事件来源、关联活动ID等'
             },
             
             // Link information
             link_id: {
               type: 'string',
-              description: 'ID of the associated short link'
+              description: '短链接的唯一标识符，用于关联事件与特定短链接'
             },
             link_slug: {
               type: 'string',
-              description: 'Slug of the short link'
+              description: '短链接的短码/slug部分，即URL路径中的短字符串，用于生成短链接URL'
             },
             link_label: {
               type: 'string',
-              description: 'Label of the short link'
+              description: '短链接的标签名称，用于分类和组织管理短链接'
             },
             link_title: {
               type: 'string',
-              description: 'Title of the short link'
+              description: '短链接的标题，用于在管理界面或分析报告中显示链接的易读名称'
             },
             link_original_url: {
               type: 'string',
               format: 'uri',
-              description: 'Original URL of the short link'
+              description: '短链接对应的原始目标URL，即用户访问短链接后将被重定向到的实际URL'
             },
             link_attributes: {
               type: 'string',
-              description: 'JSON string with additional link attributes'
+              description: '链接附加属性的JSON字符串，用于存储与链接相关的自定义数据，如营销活动信息、目标受众等'
             },
             link_created_at: {
               type: 'string',
               format: 'date-time',
-              description: 'Creation time of the link'
+              description: '短链接创建时间，记录链接何时被创建'
             },
             link_expires_at: {
               type: 'string',
               format: 'date-time',
               nullable: true,
-              description: 'Expiration time of the link'
+              description: '短链接过期时间，指定链接何时失效，值为null表示永不过期'
             },
             link_tags: {
               type: 'string',
-              description: 'JSON array with link tags'
+              description: '链接标签的JSON数组字符串，用于通过标签对链接进行分类和过滤'
             },
             
             // User information
             user_id: {
               type: 'string',
-              description: 'ID of the user who created the link'
+              description: '创建链接的用户ID，用于跟踪哪个用户创建了短链接'
             },
             user_name: {
               type: 'string',
-              description: 'Name of the user'
+              description: '用户名称，用于在报表中展示更易读的用户身份'
             },
             user_email: {
               type: 'string',
               format: 'email',
-              description: 'Email of the user'
+              description: '用户电子邮件地址，可用于通知和报告分发'
             },
             user_attributes: {
               type: 'string',
-              description: 'JSON string with additional user attributes'
+              description: '用户附加属性的JSON字符串，存储用户相关的额外信息，如订阅级别、账户创建日期等'
             },
             
             // Team information
             team_id: {
               type: 'string',
-              description: 'ID of the team'
+              description: '团队ID，用于标识链接归属的团队，支持多团队使用场景'
             },
             team_name: {
               type: 'string',
-              description: 'Name of the team'
+              description: '团队名称，用于在报表和管理界面中显示更友好的团队标识'
             },
             team_attributes: {
               type: 'string',
-              description: 'JSON string with additional team attributes'
+              description: '团队附加属性的JSON字符串，存储团队相关的额外信息，如部门、地区等'
             },
             
             // Project information
             project_id: {
               type: 'string',
-              description: 'ID of the project'
+              description: '项目ID，用于将链接归类到特定项目下，便于项目级别的分析'
             },
             project_name: {
               type: 'string',
-              description: 'Name of the project'
+              description: '项目名称，提供更具描述性的项目标识，用于报表和管理界面'
             },
             project_attributes: {
               type: 'string',
-              description: 'JSON string with additional project attributes'
+              description: '项目附加属性的JSON字符串，存储项目相关的额外信息，如目标、预算等'
             },
             
             // QR code information
             qr_code_id: {
               type: 'string',
-              description: 'ID of the QR code'
+              description: '二维码ID，标识与事件关联的二维码，用于跟踪二维码的使用情况'
             },
             qr_code_name: {
               type: 'string',
-              description: 'Name of the QR code'
+              description: '二维码名称，提供更具描述性的二维码标识，便于管理和报表'
             },
             qr_code_attributes: {
               type: 'string',
-              description: 'JSON string with additional QR code attributes'
+              description: '二维码附加属性的JSON字符串，存储与二维码相关的额外信息，如尺寸、颜色、logo等'
             },
             
             // Visitor information
             visitor_id: {
               type: 'string',
               format: 'uuid',
-              description: 'Unique identifier for the visitor'
+              description: '访问者唯一标识符，用于跟踪和识别独立访问者，分析用户行为'
             },
             session_id: {
               type: 'string',
-              description: 'Session identifier'
+              description: '会话标识符，用于将同一访问者的多个事件分组到同一会话中'
             },
             ip_address: {
               type: 'string',
-              description: 'IP address of the visitor'
+              description: '访问者的IP地址，用于地理位置分析和安全监控'
             },
             country: {
               type: 'string',
-              description: 'Country of the visitor'
+              description: '访问者所在国家，用于地理分布分析'
             },
             city: {
               type: 'string',
-              description: 'City of the visitor'
+              description: '访问者所在城市，提供更精细的地理位置分析'
             },
             device_type: {
               type: 'string',
-              description: 'Type of device used'
+              description: '访问者使用的设备类型（如mobile、desktop、tablet等），用于设备分布分析'
             },
             browser: {
               type: 'string',
-              description: 'Browser used'
+              description: '访问者使用的浏览器（如Chrome、Safari、Firefox等），用于浏览器分布分析'
             },
             os: {
               type: 'string',
-              description: 'Operating system used'
+              description: '访问者使用的操作系统（如iOS、Android、Windows等），用于操作系统分布分析'
             },
             user_agent: {
               type: 'string',
-              description: 'User agent string'
+              description: '访问者的User-Agent字符串，包含有关浏览器、操作系统和设备的详细信息'
             },
             
             // Referrer information
             referrer: {
               type: 'string',
-              description: 'Referrer URL'
+              description: '引荐来源URL，指示用户从哪个网站或页面访问短链接，用于分析流量来源'
             },
             utm_source: {
               type: 'string',
-              description: 'UTM source parameter'
+              description: 'UTM来源参数，标识流量的来源渠道，如Google、Facebook、Newsletter等'
             },
             utm_medium: {
               type: 'string',
-              description: 'UTM medium parameter'
+              description: 'UTM媒介参数，标识营销媒介类型，如cpc、email、social等'
             },
             utm_campaign: {
               type: 'string',
-              description: 'UTM campaign parameter'
+              description: 'UTM活动参数，标识特定的营销活动名称，用于跟踪不同活动的效果'
             },
             
             // Interaction information
             time_spent_sec: {
               type: 'number',
-              description: 'Time spent in seconds'
+              description: '用户停留时间（秒），表示用户在目标页面上花费的时间，用于分析用户参与度'
             },
             is_bounce: {
               type: 'boolean',
-              description: 'Whether this was a bounce visit'
+              description: '是否为跳出访问，表示用户是否在查看单个页面后离开，不与网站进一步交互'
             },
             is_qr_scan: {
               type: 'boolean',
-              description: 'Whether this event came from a QR code scan'
+              description: '是否来自二维码扫描，用于区分和分析二维码带来的流量'
             },
             conversion_type: {
               type: 'string',
-              description: 'Type of conversion'
+              description: '转化类型，表示事件触发的转化类型，如注册、购买、下载等，用于细分不同类型的转化'
             },
             conversion_value: {
               type: 'number',
-              description: 'Value of the conversion'
+              description: '转化价值，表示转化事件的经济价值或重要性，如购买金额、潜在客户价值等'
             }
           }
         },
@@ -733,71 +733,71 @@ export default function SwaggerPage() {
             event_id: {
               type: 'string',
               format: 'uuid',
-              description: 'Unique identifier for the event',
+              description: '事件唯一标识符，用于唯一标识事件记录',
             },
             event_type: {
               type: 'string',
               enum: ['click', 'conversion'],
-              description: 'Type of the event',
+              description: '事件类型，用于分类不同的用户交互行为。click表示点击事件，conversion表示转化事件',
             },
             event_time: {
               type: 'string',
               format: 'date-time',
-              description: 'Time when the event occurred',
+              description: '事件发生的时间戳，记录事件发生的精确时间',
             },
             link_id: {
               type: 'string',
-              description: 'ID of the associated short link',
+              description: '短链接的唯一标识符，用于关联事件与特定短链接',
             },
             link_slug: {
               type: 'string',
-              description: 'Slug of the short link',
+              description: '短链接的短码/slug部分，即URL路径中的短字符串',
             },
             link_original_url: {
               type: 'string',
               format: 'uri',
-              description: 'Original URL of the short link',
+              description: '短链接对应的原始目标URL，即用户访问短链接后将被重定向到的实际URL',
             },
             visitor_id: {
               type: 'string',
               format: 'uuid',
-              description: 'Unique identifier for the visitor',
+              description: '访问者唯一标识符，用于跟踪和识别独立访问者，分析用户行为',
             },
             device_type: {
               type: 'string',
-              description: 'Type of device used',
+              description: '访问者使用的设备类型（如mobile、desktop、tablet等），用于设备分布分析',
             },
             browser: {
               type: 'string',
-              description: 'Browser used',
+              description: '访问者使用的浏览器（如Chrome、Safari、Firefox等），用于浏览器分布分析',
             },
             os: {
               type: 'string',
-              description: 'Operating system used',
+              description: '访问者使用的操作系统（如iOS、Android、Windows等），用于操作系统分布分析',
             },
             country: {
               type: 'string',
-              description: 'Country of the visitor',
+              description: '访问者所在国家，用于地理分布分析',
             },
             region: {
               type: 'string',
-              description: 'Region/state of the visitor',
+              description: '访问者所在地区/省份，提供中等精细度的地理位置分析',
             },
             city: {
               type: 'string',
-              description: 'City of the visitor',
+              description: '访问者所在城市，提供更精细的地理位置分析',
             },
             referrer: {
               type: 'string',
-              description: 'Referrer URL',
+              description: '引荐来源URL，指示用户从哪个网站或页面访问短链接，用于分析流量来源',
             },
             conversion_type: {
               type: 'string',
-              description: 'Type of conversion (if event_type is conversion)',
+              description: '转化类型，表示事件触发的转化类型，如注册、购买、下载等（仅当event_type为conversion时有效）',
             },
             conversion_value: {
               type: 'number',
-              description: 'Value of the conversion (if applicable)',
+              description: '转化价值，表示转化事件的经济价值或重要性，如购买金额、潜在客户价值等（仅当event_type为conversion时有效）',
             },
           },
         },
@@ -807,19 +807,19 @@ export default function SwaggerPage() {
           properties: {
             totalEvents: {
               type: 'integer',
-              description: 'Total number of events in the period',
+              description: '时间段内的事件总数，包括所有类型的事件总计',
             },
             uniqueVisitors: {
               type: 'integer',
-              description: 'Number of unique visitors',
+              description: '时间段内的独立访问者数量，基于唯一访问者ID计算',
             },
             totalConversions: {
               type: 'integer',
-              description: 'Total number of conversions',
+              description: '时间段内的转化事件总数，用于衡量营销效果',
             },
             averageTimeSpent: {
               type: 'number',
-              description: 'Average time spent in seconds',
+              description: '平均停留时间（秒），表示用户平均在目标页面上停留的时间，是用户参与度的重要指标',
             },
           },
         },
@@ -829,19 +829,19 @@ export default function SwaggerPage() {
             timestamp: {
               type: 'string',
               format: 'date-time',
-              description: 'Time point in the series',
+              description: '时间序列中的时间点，表示数据采集的精确时间',
             },
             events: {
               type: 'number',
-              description: 'Number of events at this time point',
+              description: '该时间点的事件数量，显示事件随时间的分布趋势',
             },
             visitors: {
               type: 'number',
-              description: 'Number of unique visitors at this time point',
+              description: '该时间点的独立访问者数量，显示访问者随时间的分布趋势',
             },
             conversions: {
               type: 'number',
-              description: 'Number of conversions at this time point',
+              description: '该时间点的转化数量，显示转化随时间的分布趋势',
             },
           },
         },
@@ -850,31 +850,31 @@ export default function SwaggerPage() {
           properties: {
             location: {
               type: 'string',
-              description: 'Location identifier',
+              description: '位置标识符，可以是国家、地区或城市的组合标识',
             },
             country: {
               type: 'string',
-              description: 'Country name',
+              description: '国家名称，表示访问者所在的国家',
             },
             region: {
               type: 'string',
-              description: 'Region/state name',
+              description: '地区/省份名称，表示访问者所在的地区或省份',
             },
             city: {
               type: 'string',
-              description: 'City name',
+              description: '城市名称，表示访问者所在的城市',
             },
             visits: {
               type: 'number',
-              description: 'Number of visits from this location',
+              description: '来自该位置的访问次数，用于分析不同地区的流量分布',
             },
             visitors: {
               type: 'number',
-              description: 'Number of unique visitors from this location',
+              description: '来自该位置的独立访问者数量，用于分析不同地区的用户分布',
             },
             percentage: {
               type: 'number',
-              description: 'Percentage of total visits',
+              description: '占总访问量的百分比，便于直观比较不同地区的流量占比',
             },
           },
         },
@@ -888,15 +888,15 @@ export default function SwaggerPage() {
                 properties: {
                   type: {
                     type: 'string',
-                    description: 'Device type',
+                    description: '设备类型，如mobile、desktop、tablet等，用于设备类型分析',
                   },
                   count: {
                     type: 'number',
-                    description: 'Number of visits from this device type',
+                    description: '使用该设备类型的访问次数，用于统计各类设备的使用情况',
                   },
                   percentage: {
                     type: 'number',
-                    description: 'Percentage of total visits',
+                    description: '该设备类型占总访问量的百分比，便于比较不同设备类型的使用占比',
                   },
                 },
               },
@@ -908,15 +908,15 @@ export default function SwaggerPage() {
                 properties: {
                   name: {
                     type: 'string',
-                    description: 'Browser name',
+                    description: '浏览器名称，如Chrome、Safari、Firefox等，用于浏览器使用分析',
                   },
                   count: {
                     type: 'number',
-                    description: 'Number of visits from this browser',
+                    description: '使用该浏览器的访问次数，用于统计各类浏览器的使用情况',
                   },
                   percentage: {
                     type: 'number',
-                    description: 'Percentage of total visits',
+                    description: '该浏览器占总访问量的百分比，便于比较不同浏览器的使用占比',
                   },
                 },
               },
@@ -928,15 +928,15 @@ export default function SwaggerPage() {
                 properties: {
                   name: {
                     type: 'string',
-                    description: 'Operating system name',
+                    description: '操作系统名称，如iOS、Android、Windows等，用于操作系统使用分析',
                   },
                   count: {
                     type: 'number',
-                    description: 'Number of visits from this OS',
+                    description: '使用该操作系统的访问次数，用于统计各类操作系统的使用情况',
                   },
                   percentage: {
                     type: 'number',
-                    description: 'Percentage of total visits',
+                    description: '该操作系统占总访问量的百分比，便于比较不同操作系统的使用占比',
                   },
                 },
               },
@@ -949,19 +949,19 @@ export default function SwaggerPage() {
           properties: {
             page: {
               type: 'integer',
-              description: 'Current page number',
+              description: '当前页码，表示结果集中的当前页面位置',
             },
             pageSize: {
               type: 'integer',
-              description: 'Number of items per page',
+              description: '每页项目数，表示每页显示的结果数量',
             },
             totalItems: {
               type: 'integer',
-              description: 'Total number of items',
+              description: '总项目数，表示符合查询条件的结果总数',
             },
             totalPages: {
               type: 'integer',
-              description: 'Total number of pages',
+              description: '总页数，基于总项目数和每页项目数计算得出',
             },
           },
         },
@@ -971,11 +971,11 @@ export default function SwaggerPage() {
           properties: {
             code: {
               type: 'string',
-              description: 'Error code',
+              description: '错误代码，用于标识特定类型的错误，便于客户端处理不同错误情况',
             },
             message: {
               type: 'string',
-              description: 'Error message',
+              description: '错误消息，提供关于错误的人类可读描述，帮助理解错误原因',
             },
           },
         },