智能报告

功能介绍

基调听云智能报告主要为基调听云平台用户提供一套自定义报告功能，实现定时发送、周期发送和自定义数据采集。支持自定义创建报告和基于模板创建报告。

目前报告支持添加七种不同的图表类型：饼状、柱状、折线、雷达图、中国地图、健康度和列表。

使用指南

我的报告

系统支持自定义创建报告和基于模板创建报告。

自定义创建

用户可自主配置和丰富报告的内容，可对报告进行排版、评论、布局等。创建一个报告，请按照以下步骤进行操作。

在左侧导航栏，选择"全部应用"，并在弹出的轻应用列表中选择"数据洞察 > 智能报告"。

也可以在左侧的Dock栏中点击智能报告的轻应用来进入。
单击"分页报告"按钮。
配置装饰。

装饰里提供了文字、头部装饰、尾部装饰、标题和文件组件。
配置组件。

组件为报告提供的第三方数据能力，这里提供了基本的折线图、柱状图、饼图等图表类型，可支持数据库、API和静态数据等数据类型进行接入，其中数据库支持MySQL、Postgre SQL、DB。

选中图表，单击右侧"数据配置"按钮，即可对接入的数据进行配置，再次单击可收起配置区域。示例如下：
（可选）单击右上角的"预览"按钮，可随时预览报告效果。
单击右上角的"保存"按钮，保存报告配置。

新创建的报告将显示在报告列表中。

分页报告

分页报告模式主要是为了提高编辑操作体验，尽可能地在编辑布局时和导出报告时按照1：1比例进行还原。

分页报告分为4个区域：标题栏区域、左侧边栏区域、编辑区域和右侧边栏区域。

标题栏区域

在标题区域单击可以对报告名称进行重命名（单击报告的"保存"按钮后即可生效）。
在功能区域单击"保存"可以对当前编辑的报告进行保存（报告默认5分钟保存一次）。
在功能区域单击"预览"，浏览器打开新的页签，可预览展示当前报告。
在功能区域单击时间选框，可以指定最近90天内任意的时间范围进行查询。

左侧边栏区域

单击拖动区域可以调整报告页面展示顺序。
单击新增一个无标题页面的空白分页。
单击可以将左侧边栏收起；单击可以将收起的边栏展开。
单击可以对当前分页进行重命名和删除操作。

编辑区域

编辑区域包括：装饰区域、公共组件库和画布区域。在该区域，您可以对报告进行布局、排版、快捷操作以及选择需要的图标等等。

装饰区域：单击"装饰"下拉菜单会展示装饰组件弹窗，装饰组件支持单击或拖动到画布区域使用。

说明：目前装饰区域内的组件为官网默认提供，不可进行增删。

公共组件库：公共组件库默认提供9个组件，均可以进行外部数据接入，支持接入（包含但不限于）API、数据库、CSV等数据。
画布：您可以对画布进行以下操作。
- 在画布区域，支持选择一个或者多个图表。
- 鼠标右击可对图表进行：剪切、删除、复制、粘贴、从剪切板粘贴、置顶、置底、上移一层、下移一层操作。
- 选中组件后可以对组件进行自由拖动和布局。
- 如果在其他活动窗口使用QQ等第三方截图软件，对窗口或者页面进行截图后，当进入报告画布后，单击从剪切板进行粘贴可将第三方截图粘贴到本页面使用。
- 画布全区域支持快捷键操作，快捷键功能如下：
- 单击并拖动组件上的4个顶点，可对画布进行等比例缩放。

右侧边框区域

右侧边栏区域为报告全局配置和单个组件配置操作区域，包括基础配置和数据配置。

全局配置
- 画布尺寸提供：1200×900、900×1200、1366 ×768和768×1366 。
- 像素：自定义宽高像素。
- 网格：是否开启网格（主要用来布局报告时做参考线）。
- 预览和导出页面配置：默认是所有页面，也可以自定义页面预览或导出。
单组件个性化配置
- 公共组件库组件配置：配置数据接入方式（包含API、Demo数据）和数据过滤器。

模板创建

模版报告主要是为了降低用户的使用成本，产品会继续迭代新增更多场景模版。基于模板创建一个报告，请按照以下步骤进行操作。

在左侧导航栏，选择"全部应用"，并在弹出的轻应用列表中选择"数据洞察 > 智能报告"。
单击"模板报告"按钮。
选择模板，单击"确定"按钮。

（可选）单击右上角的预览按钮，可随时预览报告效果。
单击右上角的"保存"按钮，保存报告配置。

报告列表

报告列表展示已创建的所有报告。在报告列表页面，您可以进行以下操作：

单击创建时间、最后发送时间后的图标，可由远到近排序，单击图标，可由近到远排序。
发送对象：当前报告发送的接收人。
启停：可对创建在计划发送中的报告进行启用和停用。
搜索报告：单击报告列表右上角的搜索框，可对报告进行模糊搜索。
创建报告：单击报告列表左上角的"创建"按钮，可选择自定义创建和模版创建

发送设置

在左侧导航栏，选择"全部应用"，并在弹出的轻应用列表中选择"智能报告"。
在目标报告的"操作"列单击"发送设置"链接，进入发送设置页面。
选择发送规则。如果还没有创建发送规则，单击"新建"链接进行创建。
- 自定义规则名称。
- 设置发送频率，包括定期发送和周期发送两种模式。
  
  定期发送支持单次指定发送日期。周期发送提供工作日模式和指定日期模式进行发送。工作日模式可以选择从周一到周日的任意时间发送。
- 设置数据采集。用户可以自定义报告中图表采集数据的时间。
  - 相对时间数据采集：数据采集时间是从报告发送的时间往前推N个自然日。
  - 指定时间范围数据采集：选择开始时间和结束时间后，发送的报告中仅会展示该时间范围内的图表数据。仅单次发送支持该模式的设置。
- 单击确定，完成发送规则配置。
配置报告接收人。
- 平台接收人：将报告发送到平台已经配置好的接收人邮箱中。配置接收人，请在"用户中心">"推送配置"中进行配置。
- 邮件接收人：将报告发送到外部联系人的邮箱中。多个邮箱之间用英文逗号隔开。
配置报告的接收格式。

报告支持以PDF、EXCEL、JSON格式的附件发送。当勾选多种格式时，系统会以压缩包的形式发送到邮箱。

发送日志

发送日志列表展示最近3个月已发送的报告的名称、最后发送时间、发送对象、发送状态、附件类型和操作。

发送时间：展示报告最后一次发送的时间。
名称：报告名称。
发送对象：展示报告邮件接收人列表。
发送状态：展示最后一次发送邮件的状态。
附件类型：展示发送报告的格式。
操作：单击"操作"列的"下载"链接，可对发送成功的附件进行下载。

API接入规范

地图

组件名称：地图

组件描述：世界地图、中国地图、省份地图

组件样式：

中国地图：

世界地图：

北京市地图：

请求参数：图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数。
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object	是	响应结果
value	Number	否	平均值
unit	String	否	单位
map	String	是	地图类型，世界地图world，中国地图china，省份地图传拼音比如beijing，hebei，其中山西(shanxi)、陕西(shanxi1)
series	Object[]	是	数据项
name	String	是	数据项名称
value	Number	是	数据项值

示例：

{
    "status": 200,
    "msg": "success",
    "data": {
        "value": 1.68,
        "unit": "秒",
        "map":"china",
        "series": [
            {
                "name": "北京",
                "value": 800
            },
            {
                "name": "上海",
                "value": 580
            }
        ]
    }
}

数据库接入、CSV接入： SQL查询结果和CSV文件内容均为4列，字段名称可以任意指定，但是字段顺序不能改变。

字段	类型	描述
name	String	名
value	String	值
map	String	地图类型，世界地图world，中国地图china，省份地图传拼音比如beijing，hebei，其中山西(shanxi)、陕西(shanxi1)
unit	String	单位

以MySQL为例，SQL示例如下：

SELECT name, value, map, unit FROM demo

CSV示例如下：

name,value,map,unit
北京,1000,china,s
上海,800,
广东,500,
深圳,300,

折线图

组件名称：折线图

组件样式：折线图、柱状+折线图、Apdex折线图

请求参数：

图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object	是	响应结果
value	Number	否	平均值
stacked	Number	否	series中的柱状图是否堆叠，0为不堆叠，1为堆叠，默认为0
area	Number	否	series中的line图是否堆叠，0为不堆叠，1为堆叠，默认为0
yAxis	Object[]	是	y轴配置，最多两条数据，第一条在左侧，第二条在右侧
name/tickUnit	String	是	坐标轴单位
series	Object[]	是	数据对象
name	String	是	数据项名称
type	String	是	line折线图，column柱状图，bar条形图，area堆叠折线图
yAxis/yAxisIndex	Number	否	数据对应y轴，从0开始，默认为0
data	Object[]	是	图表数据项
x	Number	是	时间戳序列
y	Number	是	值

示例：

{
    "status/code": 200,
    "msg": "success",
    "data": {
        "value": 123,
        "yAxis": [
            {
                "tickUnit": "秒"
            },
            {
                "tickUnit": "次"
            }
        ],
        "forward": 0,
        "stack": 0,
        "area": 0,
        "series": [
            {
                "name": "响应时间",
                "type": "line",
                "data": [
                    {
                        "x": 1544496360000,
                        "y": 122
                    },
                    {
                        "x": 1544496420000,
                        "y": 422
                    }
                ]
            },
            {
                "name": "访问量",
                "type": "bar",
                "yAxis": 1,
                "data": [
                    {
                        "x": 1544496360000,
                        "y": 22
                    },
                    {
                        "x": 1544496420000,
                        "y": 122
                    }
                ]
            }
        ]
    }
}

柱状图

组件名称：柱状图

组件描述：柱状图、堆叠柱状图

组件样式：

请求参数：

图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object	是	响应结果
forward	Number	否	0为横向，1为纵向，默认为0
legend	Object	否	图例配置
data	Array[]	否	图例数据，跟series集合里面的name一致
yAxis	Object[]	是	y轴配置
name/tickUnit	String	是	坐标轴单位
xAxis	Object	是	x轴配置
type	String	是	固定值category
data	Array[]	是	x轴数据
series	Object[]	是	数据对象
name	String	是	数据项名称
type	String	是	固定值column/bar
stack	String	否	数据堆叠，同个类目轴上系列配置相同的stack值可以堆叠放置。
data	Array[]	是	图表数据项

示例：

{
    "status/code": 200,
    "msg": "success",
    "data": {
        "forward": 0,
        "legend": {
            "data": ["直接访问", "联盟广告", "视频广告", "其他"]
        },
        "yAxis": [{
            "type":"value",
            "name": "次数"
        }],
        "xAxis": [{
            "type": "category",
            "data": ["周一", "周二", "周三", "周四", "周五", "周六", "周日"]
        }],
        "series": [
            {
                "name": "直接访问",
                "type": "bar",
                "data": [320, 332, 301, 334, 390, 330, 320]
            },
            {
                "name": "联盟广告",
                "type": "bar",
                "stack": "广告",
                "data": [120, 132, 101, 134, 90, 230, 210]
            },
            {
                "name": "视频广告",
                "type": "bar",
                "stack": "广告",
                "data": [220, 182, 191, 234, 290, 330, 310]
            },
            {
                "name": "其他",
                "type": "bar",
                "data": [150, 232, 201, 154, 190, 330, 410]
            }
        ]
    }

健康图

组件名称：健康度柱状图

组件样式：

请求参数：图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object[]	是	响应结果
beginTime	Number	是	开始时间
endTime	Number	是	结束时间
eventLevel	Number	是	健康度级别

示例：

{
    "status": 200,
    "msg": "success",
    "data": [
        {
            "beginTime":1594954800000,
            "endTime":1597632360000,
            "eventLevel":-1
        }
    ]
}

数据库接入、CSV接入： SQL查询结果和CSV文件内容均为3列，字段名称可以任意指定，但是字段顺序不能改变。

字段	类型	描述
beginTime	Date	开始时间
endTime	Date	结束时间
eventLevel	String	健康度级别

以MySQL为例，SQL示例如下：

SELECT beginTime,endTime,eventLevel FROM demo

CSV示例如下：

beginTime,endTime,eventLevel
1628655933168,1628763933168,-1
1628763933168,1628943933168,1
1628943933168,1629015933168,2
1629015933168,1629116733168,0

饼图

组件名称：饼状图

组件样式：

请求参数：图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object	是	响应结果
value	Number	否	平均值
unit	String	否	单位
series	Object[]	是	数据对象
name	String	否	数据项名称
data	Object[]	是	数据项
name	String	是	数据项展示
value	Number	是	数据项值

示例：

{
    "status/code": 200,
    "msg": "success",
    "data": {
        "value": 1.68,
        "unit": "秒",
        "series": [
            {
                "name": "DNS",
                "data": [
                    {
                        "name": "wgz",
                        "value": 16
                    },
                    {
                        "name": "wgz2",
                        "value": 6
                    }
                ]
            }
        ]
    }
}

数据库接入、CSV接入： SQL查询结果和CSV文件内容均为3列，字段名称可以任意指定，但是字段顺序不能改变。

字段	类型	描述
name1	String	数据项名称
name2	String	数据项展示
value	String	值

以MySQL为例，SQL示例如下：

SELECT name1,name2,value FROM demo

CSV示例如下：

name1,name2,value
DNS,错误率,111
DNS,吞吐率,222

雷达图

组件名称：雷达图

组件样式：

请求参数：

图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为 yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功 200，非 200 统一无数据处理
msg	String	否	请求响应信息
data	Object	是	响应结果
value	Number	否	雷达中间指标值
unit	String	否	单位
indicator	Object[]	是	指标项及名称
name	String	是	指标项名称
max	Number	是	指标项最大值
series	Object[]	是	数据对象
name	String	是	数据项名称
value	Object[]	是	数据项值

示例：

{
    "status": 200,
    "msg": "success",
    "data": {
        "value": 67,
        "indicator": [
            {
                "name": "指标A",
                "max": 100
            },
            {
                "name": "指标B",
                "max": 100
            },
            {
                "name": "指标C",
                "max": 100
            },
            {
                "name": "指标D",
                "max": 100
            },
            {
                "name": "指标E",
                "max": 100
            },
            {
                "name": "指标F",
                "max": 100
            }
        ],
        "series": [
            {
                "name": "行业",
                "value": [
                    89,
                    90,
                    99,
                    96,
                    97,
                    95
                ]
            },
            {
                "name": "当前",
                "value": [
                    70,
                    60,
                    40,
                    30,
                    50,
                    95
                ]
            }
        ]
    }
}

数据库接入、CSV 接入： SQL查询结果和CSV文件内容均为5列，字段名称可以任意指定，但是字段顺序不能改变。

字段	类型	描述
value1	Number	雷达图数值
name1	String	指标名称
max	String	指标最大值
name2	String	数据名称
value2	String	数据值

以 MySQL 为例，SQL 示例如下：

SELECT value1,name1,max,name2,value2 FROM demo

CSV 示例如下：

value1,name1,max,name2,value2
15,1响应时间,100,数据一1,72
15,2消耗流量,100,数据一1,74
15,3卡顿率,100,数据一1,43
15,4错误率,100,数据一1,60
15,5崩溃率,100,数据一1,78
15,6新增一列,100,数据一1,88
15,1响应时间,100,数据二2,61
15,2消耗流量,100,数据二2,57
15,3卡顿率,100,数据二2,82
15,4错误率,100,数据二2,48
15,5崩溃率,100,数据二2,40
15,6新增一列,100,数据二2,11

列表图

组件名称：列表

组件样式：

请求参数：

图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	必须返回	说明
status	Number	是	请求返回状态，成功200，非200统一无数据处理
msg	String	否	请求响应信息
data	Object[]	是	响应结果
header	Object[]	是	表格头部信息对象
key	Object	是	key为表格数据属性对应的值，value为表格头部标题文本
rows	Object[]	是	表格头部信息对象
rows	Object	是	表格行数据对象，key必须跟header对应

示例：

    {
    "status/code": 200,
    "msg":"",
    "data": [
        {
            "header": [
                {"key1":"健康度"},
                {"key2":"业务系统"},
                {"key3":"响应时间"},
                {"key4":"吞吐率"},
                {"key5":"峰值吞吐率"}
            ],
            "rows": [
                {"key1":"良好","key2":80,"key3":"卡顿","key4":"12%","key5":"12%"},
                {"key1":"一般","key2":80,"key3":"崩溃","key4":"12%","key5":"12%"},
                {"key1":"严重","key2":80,"key3":"想用时间","key4":"12%","key5":"12%"}
            ]
        }
    ]
}

数据库接入、CSV接入： SQL查询结果和CSV文件内容字段名称可以任意指定。

字段	类型	描述
name1	String	列名
name2	String	列名
name3	String	列名

以MySQL为例，SQL示例如下：

SELECT name1,name2,name3,... FROM demo

CSV示例如下：

健康度,业务系统,响应时间,吞吐率,峰值吞吐率
良好,80,卡顿,12%,12%
一般,80,崩溃,12%,12%
严重,80,崩溃,12%,12%

多功能图

组件名称：多功能图表、可转换图表

组件描述：图表内部可进行转换

组件样式：

使用步骤：

进行数据配置。
选择可转换的图表，目前支持折线图，柱状图，饼状图，散点图，漏斗图，表格（计划后续支持：地图等）。
（可选）通过开发者配置定制图表（通过修改option配置对象可定制图表，option请参考ECharts5配置对象）。

开发者模式提供的全局对象：
- 全局jquery,$,echarts对象。
- 当前图表chart实例。
- 第三方数据接入返回的data。

请求参数：

图表接口必须支持分钟数和结束时间参数，以满足数读报告可以动态调整时间获取数据。

请求参数	类型	必选参数	说明
timePeriod	Number	是	分钟数
endTime	String	是	结束时间，格式为 yyyy-MM-dd HH:mm

正确响应数据：

字段	类型	描述
status	Number	状态码
data	Object
dataset	Array	数据集
source	Array[]	源数据

示例：

{
    "status": 200,
    "data": {
        "dataset": {
            "source": [
                [
                    "date",
                    "Matcha Latte",
                    "Milk Tea",
                    "Cheese Cocoa",
                    "Walnut Brownie"
                ],
                [
                    "2015",
                    43.3,
                    83.1,
                    86.4,
                    72.4
                ],
                [
                    "2016",
                    85.8,
                    73.4,
                    65.2,
                    53.9
                ],
                [
                    "2017",
                    93.7,
                    55.1,
                    82.5,
                    39.1
                ]
            ]
        }
}
}

数据库接入、CSV 接入： SQL查询结果和CSV文件字段名称可以任意指定，第一列为日期，后面每一列为一个对象的数据：

以 MySQL 为例，SQL 示例如下：

SELECT column1,column2,column3,... FROM demo

CSV 示例如下：

date,Matcha Latte,Milk Tea,Cheese Cocoa,Walnut Brownie
2015,43.3,83.1,86.4,72.4
2016,85.8,73.4,65.2,53.9
2017,93.7,55.1,82.5,39.1

功能介绍​

使用指南​

我的报告​

自定义创建​

分页报告​

标题栏区域​

左侧边栏区域​

编辑区域​

右侧边框区域​

模板创建​

报告列表​

发送设置​

发送日志​

API接入规范​

地图​

折线图​

柱状图​

健康图​

饼图​

雷达图​

列表图​

多功能图​

功能介绍

使用指南

我的报告

自定义创建

分页报告

标题栏区域

左侧边栏区域

编辑区域

右侧边框区域

模板创建

报告列表

发送设置

发送日志

API接入规范

地图

折线图

柱状图

健康图

饼图

雷达图

列表图

多功能图