# 查询轨迹事件


- ActivityId=旅程记录id(事件id)
- parentActivityId 为空，说明为主事件（用户访问营销素材的行为主事件），如：访问了XXX文章
- parentActivityId有值，说明为子事件，如：停留了25秒、分享了文章

```
POST https://qw-openapi-tx.dustess.com/open-integration-api/trail/v2/query?accessToken=

Content-Type: application/json
```

**应用场景**

  查询客户上报的内容。

**接口限制**

  每分钟请求60次。

**Params:**

| 字段        | 类型     | 描述        | 是否必须 |
| ----------- | -------- | ----------- | -------- |
| accessToken | `String` | accessToken | true     |

**请求参数**

| 参数       | 类型   | 描述                                                                                                  | 是否必须 |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------- | -------- |
| trailId    | `String` | 项目id（传固定ID：56d3c3371f0142859ca05b031c363bdc）                                                              | 是       |
| queryDate  | `String` | 查询时间（拉取某一天0点-24点的数据。格式：yyyy-MM-dd，如果customerId和unionId都为空时，查询时间必传） | 否       |
| customerId | `String` | 客户id（查询customerId和其关联的unionId上报的所有事件）                                               | 否       |
| unionId    | `String` | 微信用户id（customerId和unionId都传的时候，以customerId查询）                                         | 否       |
| page       | `Int`    | 页码（默认从第一页开始）                                                                              | 否       |
| pageSize   | `Int`    | 每页显示记录数（单页最大500，默认10）                                                                 | 否       |


**请求示例**
```json
{
    "trailId": "56d3c3371f0142859ca05b031c363bdc",
    "queryDate": "2022-07-25",
    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
    "page": 1,
    "pageSize": 100
}
```

**响应结果**

| 参数                       | 类型       | 描述                                                                                                           |
| -------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------- |
| code                       | `Int`      | 状态码                                                                                                         |
| msg                        | `String`   | 状态信息                                                                                                       |
| success                    | `Boolean`  | 是否成功                                                                                                       |
| data                       | `Object`   | 响应内容                                                                                                       |
| data.page                  | `Int`      | 页码                                                                                                           |
| data.pageSize              | `Int`      | 每页显示记录数                                                                                                 |
| data.total                 | `Int`      | 总记录数                                                                                                       |
| data.data                  | `Object[]` | 总记录数                                                                                                       |
| data.data.id               | `String`   | 事件记录id                                                                                                     |
| data.data.account          | `String`   | 公司id                                                                                                         |
| data.data.activityId       | `String`   | 旅程记录id                                                                                                     |
| data.data.parentActivityId | `String`   | 上级旅程记录id                                                                                                 |
| data.data.operatorId       | `String`   | 操作人id(员工id)                                                                                               |
| data.data.operatorType     | `String`   | 操作人类型,固定为EMPLOYEE(员工)                                                                                |
| data.data.unionId          | `String`   | 微信用户id                                                                                                     |
| data.data.customerId       | `String`   | 客户id                                                                                                         |
| data.data.event            | `String`   | 事件(系统已存在行为轨迹事件详见[轨迹参数说明](https://open.dustess.com/doc-5147977.md))                                 |
| data.data.trailId          | `String`   | 项目id                                                                                                         |
| data.data.subject          | `String`   | 所属对象,固定为:CUSTOMER(客户)                                                                                 |
| data.data.targetId         | `String`   | 操作对象id,可能是unionId、customerId，根据targetType判断                                                       |
| data.data.targetType       | `String`   | 操作对象类型,WX、CUSTOMER                                                                                      |                                                                                      |
| data.data.reportTime       | `Int`      | 上报时间戳                                                                                                     |
| data.data.operateTime      | `Int`      | 发生时间戳                                                                                                     |
| data.data.createTime       | `String`   | 入库时间                                                                                                       |
| data.data.updateTime       | `String`   | 更新时间                                                                                                       |
| data.data.stayTime         | `Int`      | 停留时间戳                                                                                                     |
| data.data.date             | `String`   | 日期                                                                                                           |
| data.data.time             | `String`   | 时间                                                                                                           |
| data.data.extraInfo        | `Object`   | 额外自定义信息(系统已存在行为轨迹事件自定义字段信息详见[轨迹参数说明](https://open.dustess.com/doc-5147977.md)) |
| data.data.children         | `Object[]` | 下级旅程记录列表                                                                                               |
| trace_id                   | `String`   | 链路id                                                                                                         |



**extraInfo内容信息说明**

```json
{
    "account": "租户ID，必填",
    "customerId": "客户Id，非必填 微信生态联系人id,非微信生态 cookieId ",
    "unionId": "用户unionId，非必填 ",
    "event": "事件，必填",
    "activityId": "记录唯一ID，ID重复会根据配置更新字段，不产生新记录",
    "version": 1,
    "parentActivityId": "父级记录唯一ID",
    "operator": "操作人ID，非必填",
    "reportTime": "上报时间，格式为2021-10-12 10:10:10",
    "relationId": "关联主体id 非必填",
    "attr": {
        "deliverType": "来源类型（staffShare员工分享 publicLaunch公域投放 advertising广告投放）",
        "sourceId": "来源ID（员工id, 来源ID）(链接带参)",
        "deviceId": "设备Id，非必填",
        "deviceManufacturer": "设备制造商 非必填",
        "deviceModel": "设备型号 非必填",
        "browser": "当前访问的浏览器，如'微信浏览'非必填",
        "country": "国家 非必填",
        "province": "省 非必填",
        "city": "市 非必填",
        "area": "区 非必填",
        "platform": "平台：WPN（公众号）/MINI（小程序）/QW（企微）/OTHER(第三方) 必填",
        "contentId": "内容id （可以是表单id、文章Id、商品Id、案例Id..，此字段不做强制校验，因为是全链路需要兼容无素材id情况）",
        "reportType": "wx:unionId上报  customer:联系人id上报  cookie:cookie上报  ",
        "sceneType": "material(营销资料)，miniMaterial(小程序素材)，commonMaterial(普通素材)，hotMaterial(热门营销资料)，hot-article(热门好文-营销资料类型)，redPacket(红包)，dynamic(企业动态)，tempMaterial，marketingRedPacket(营销红包)，card(名片)，living(直播)，fission(裂变活动)，microSite，phone(手机号)，tel(座机)，address(通讯录)，fissionTemp(营销获客)",
        "shareType": "分享人类型  :微信用户（存在unionId）staff:员工 selfVisit：自主访问（存在的场景是用户自己通过搜索名片进行访问）非必填",
        "actionType": "电话：phone，微信：wechat，邮箱：email 非必填",
        "shareId": "分享人id 例如unionid|staffId,非必填",
        "compatibleShareId": "为了兼容老的已经发送出去的链接，此字段用于存储之前的shareId",
        "firstScene": "一级场景:2001(文章)，2002(表单)，2003(H5)，2004(案例库)，2005(宣传册)，2006(视频)，2007(文件)，2008(销售名片)，2009(名片小程序),2010(营销视频),2011(企业动态),2012(H5商城),2013(小程序商城),2014(营销红包),2015(商品),9999(其他)",
        "secondScene": "二级场景,0(销售分享)，1:(客户转发),2:(自主访问)",
        "ruleIds": "5d846128-8d6e-11ed-a9d2-aaa8e229953f,db1afcfb-4ebd-4693-ab37-8ca7dbff956f(规则id，可能存在多个，使用英文逗号分隔)",
        "externalUserId": "外部联系人id",
        "contentId": "素材ID[查询素材详情](https://open.dustess.com/doc-5158628.md)",
        "uid": "员工id",
        "addFriendTime": "添加好友时间，格式yyyy-MM-dd HH:mm:ss",
        "submitFormId": "提交表单id",
        "carrier": {
            "channel": "通道  1v1Message:1v1消息-0, groupMessage:群聊消息-1, qwMoments:企微朋友圈-2, friendCircle:个微朋友圈-3, friend:微信好友-4, microMass:微群发-5,groupMass:群群发-6",
            "carrierType": "载体类型 例如：mkPlan:营销计划、massPlan:群发",
            "carrierId": "对应载体类型的 任务id",
            "extra": "plainId等其他的信息"
        },
        "stayTime": "停留时长（单位秒）",
        "viewRatio": "播放比例 （百分比）10.00"
    }
}

```



**成功响应示例**
```json
{
    "code": 0,
    "msg": "成功",
    "data": {
        "page": 1,
        "pageSize": 10,
        "total": 1,
        "data": [{
            "id": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d#1",
            "account": "W00000000109",
            "activityId": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d",
            "parentActivityId": "",
            "operatorId": "2783",
            "operatorType": "EMPLOYEE",
            "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "event": "enterPageActivity",
            "trailId": "56d3c3371f0142859ca05b031c363bdc",
            "subject": "CUSTOMER",
            "eventType": "ACTIVITY",
            "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
            "targetType": "WX",
            "effectId": "",
            "effectType": "card",
            "effectName": "",
            "deviceId": "",
            "deviceInfo": "",
            "bizId": "2b660bc9-c8a6-4b0f-9dd9-94251f62db5d#1",
            "reportTime": 1648097916300,
            "operateTime": 1648097916300,
            "createTime": "2022-03-24 12:58:36",
            "updateTime": "2022-03-25 10:27:55",
            "stayTime": 0,
            "date": "03月24日",
            "time": "12:58",
            "extraInfo": {
                "platform": "MINI"
            },
            "children": [{
                    "id": "1ba8b12b-ab2f-11ec-b563-d29bb107c48b#3",
                    "account": "W00000000109",
                    "activityId": "1bca1826-ab2f-11ec-a12f-22943c823276",
                    "parentActivityId": "961d23e0-b0ca-4263-b3c2-9a62640d523c",
                    "operatorId": "2783",
                    "operatorType": "EMPLOYEE",
                    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "event": "stayActivity",
                    "trailId": "56d3c3371f0142859ca05b031c363bdc",
                    "subject": "CUSTOMER",
                    "eventType": "ACTIVITY",
                    "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "targetType": "WX",
                    "effectId": "4ece6410-a5d7-11ec-a160-02ab67da82b0",
                    "effectType": "article",
                    "effectName": "",
                    "deviceId": "",
                    "deviceInfo": "",
                    "bizId": "1ba8b12b-ab2f-11ec-b563-d29bb107c48b#3",
                    "reportTime": 1648097935749,
                    "operateTime": 1648097935749,
                    "createTime": "2022-03-24 12:58:55",
                    "updateTime": "2022-03-25 10:27:55",
                    "stayTime": 0,
                    "date": "03月24日",
                    "time": "12:58",
                    "extraInfo": {
                        "platform": "MINI"
                    },
                    "children": []
                },
                {
                    "id": "744ba567-ab2f-11ec-b563-d29bb107c48b#3",
                    "account": "W00000000109",
                    "activityId": "74720f2f-ab2f-11ec-a12f-22943c823276",
                    "parentActivityId": "961d23e0-b0ca-4263-b3c2-9a62640d523c",
                    "operatorId": "2783",
                    "operatorType": "EMPLOYEE",
                    "unionId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "customerId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "event": "leavePageActivity",
                    "trailId": "56d3c3371f0142859ca05b031c363bdc",
                    "subject": "CUSTOMER",
                    "eventType": "ACTIVITY",
                    "targetId": "owx_AwIYB2E7w73AmzcrEFkUv2Y8",
                    "targetType": "WX",
                    "effectId": "4ece6410-a5d7-11ec-a160-02ab67da82b0",
                    "effectType": "article",
                    "effectName": "",
                    "deviceId": "",
                    "deviceInfo": "",
                    "bizId": "744ba567-ab2f-11ec-b563-d29bb107c48b#3",
                    "reportTime": 1648098084456,
                    "operateTime": 1648098084456,
                    "createTime": "2022-03-24 13:01:24",
                    "updateTime": "2022-03-25 10:27:55",
                    "stayTime": 0,
                    "date": "03月24日",
                    "time": "13:01",
                    "extraInfo": {
                        "platform": "MINI"
                    },
                    "children": []
                }
            ]
        }]
    },
    "trace_id": "51ca6690e2f94eb1980bad01a465e78b",
    "success": true
}
```

**错误响应示例**

```json
 {
    "success": false,
    "code": 10001,
    "msg": "system unknown error",
    "data": null
}
``



