数据上报

此功能需要用户具有一定研发能力才能使用，主要用于将数据上报到指定服务器中。

大部分用户，采集完数据之后，都需要进行二次加工才能获取到自己需要的数据。例如通过扣子工作流进行数据分析、上传到飞书进行汇总、集成到自己的业务系统中等。

通过此功能，用户可以将采集到的数据，上传到任意服务之中，想怎么处理就怎么处理。

配置规则

规则可以有多个，互不冲突。符合URL匹配规则中的任意一条规则的都会上报至回调接口之中。

添加规则

规则名称

规则的名称，用于标识不同规则。

接口地址

用于接收上报数据的API接口地址。

请求方法

用于接收上报数据的API接口的请求方法（POST、PUT、PATCH）。

请求头配置

用于接收上报数据的API接口所需的请求头，可配置自己的鉴权参数信息。Content-Type默认为application/json; charset=utf-8。

开始上报

普通用户每天最多可一键上报5次；批量上报10次，且数据量需小于指定值（评论数据：100条/次，其他数据：10条/次），VIP用户无限制。

配置完成规则后，点击采集完成后的数据上报按钮，或点击插件在页面植入的数据上报按钮，即可开始上报数据。

上报接口

配置规则时填写的接口信息，可通过规则名称区分不同接口。

额外参数

需要上报的额外参数信息，可为空，上报时会包含在请求body之中，以JSON对象的形式存放于extra字段中。

备注

需要上报的备注信息，可为空，上报时会包含在请求body之中，存放于remark字段中，字符串格式。

本次会话不再弹框

此选项以及自定义上报字段仅会在网页植入按钮中展示

勾选后，当前会话后续点击数据上报按钮，将直接使用当前的输入参数进行上报，不再弹窗提示用户确认。直到浏览器重启后，弹框才会再次出现。

上报内容

上报内容为JSON格式，放在请求body之中，目前共四个字段。


{
    "extra": {}, // 额外参数，JSON对象格式
    "meta": [
        {
            "key": "string", // 对应list中每个对象的key，多层级将以`.`分隔
            "name": "string", // 字段的中文名
            "alias": "string", // 用户设置的别名
            "description": "string" // 字段的详细说明
        }
    ], // 元数据，JSON数组格式，存放的是list中的每个字段的说明
    "list": [], // 实际存放的上报数据，JSON数组格式
    "remark": "string", // 备注信息，字符串格式
    "version": "string", // 当前插件版本，字符串格式
}

Request Body

CORS

上报接口务必开启CORS，否则将可能无法成功上报。

CORS

代码示例

下面的示例为NodeJS的express框架服务，/reporting就是用于接收上报数据的接口，获取到数据后可自行处理，例如提交到Coze工作流、保存到数据库等。


const express = require('express');
const cors = require('cors');
const bodyParser = require('body-parser');
 
const app = express();
// 开启跨域支持
app.use(cors());
// body解析
app.use(bodyParser.json());
 
app.get('/', (req, res) => {
  res.send('Hello World!');
});
 
app.post('/reporting', async (req, res) => {
  const { extra, meta, list, remark, version } = req.body;
  console.log(`接收到上报数据. version: ${version}, extra: ${JSON.stringify(extra)}, meta: ${JSON.stringify(meta)}, list: ${JSON.stringify(list)}, remark: ${remark}`);
  res.json();
});
 
app.listen(8080);