查询客流数据

POST

https://api2.hik-cloud.com/api/v1/open/systems/videos/actions/countingSearch

接口描述
根据条件获取客流数据

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/open/systems/videos/actions/countingSearch' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{

             
        "deviceSerial": "xxxxx",

             
        "channelNo": 1,

             
        "statisticType": "enternum",

             
        "reportType": "daily",

             
        "timeSpanList": [

             
            {

             
                "startTime": "2020-12-23T10:00:00+08:00",

             
                "endTime": "2020-12-23T23:59:59+08:00"

             
            }

             
        ],

             
        "triggerPeopleCountingData": true,

             
        "pagingSearchCond": {

             
            "searchId": "xxxx",

             
            "searchResultPosition": 0,

             
            "maxResults": 100

             
        },

             
        "minTimeInterval": "quarter",

             
        "child": false,

             
        "faceAttribute": {

             
            "faceExpression": "poker",

             
            "gender": "female",

             
            "mask": "yes",

             
            "ageGroup": "young",

             
            "glass": "yes"

             
        },

             
        "regionId": "1,2"

             
    }'

响应示例

{
  "code": 200,
  "message": "操作成功",
  "data": [
    {
      "timeSpan": {
        "startTime": "2020-12-23T12:00:00",
        "endTime": "2020-12-23T12:59:59"
      },
      "enterCount": 11,
      "exitCount": 11,
      "peoplePassingCount": 11,
      "duplicatePeopleCount": 11,
      "faceExpressionList": [
        {
          "value": "",
          "count": 11
        }
      ],
      "genderList": [
        {
          "value": "",
          "count": 11
        }
      ],
      "maskList": [
        {
          "value": "",
          "count": 11
        }
      ],
      "ageGroupList": [
        {
          "value": "",
          "count": 11
        }
      ],
      "glassList": [
        {
          "value": "",
          "count": 11
        }
      ],
      "regionList": [
        {
          "id": 1,
          "enterCount": 11,
          "exitCount": 11
        }
      ]
    }
  ]
}

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

deviceSerial

string

设备序列号

必需

channelNo

integer

通道号

必需

statisticType

string

统计类型，进入人数-enternum,离开人数-exitnum,经过人数-peoplePassing,全部-all（全部是指进入人数和离开人数）,进入离开重复人数-enterExitDuplicate，faceAttribute-人脸属性(当类型为该值时，下面参数faceAttribute中的条件才会生效)

必需

reportType

string

报表类型，daily-日报表,weekly-周报表,monthly-月报表,yearly-年报表

必需

timeSpanList

array [object {2}]

时间区间

必需

startTime

string

开始时间，格式：2020-12-23T23:59:59+08:00

必需

endTime

string

结束时间，格式：2020-12-23T23:59:59+08:00

必需

triggerPeopleCountingData

boolean

触发客流统计数据(取值: true,false)

必需

pagingSearchCond

object

依赖，triggerPeopleCountingData=true时生效

可选

searchId

string

搜索记录唯一标识,用来确认上层客户端是否为同一个(倘若是同一个,则设备记录内存,下次搜索加快速度)

必需

searchResultPosition

integer

搜索起始位置

必需

maxResults

integer

搜索最大结果

必需

minTimeInterval

string

时间周期，quarter-15分钟, half-30分钟, hour-一小时, day-天, week-周,month-月

可选

child

boolean

是否只检测儿童,为false时表示统计成人和小孩

可选

faceAttribute

object

人脸属性

可选

faceExpression

string

人脸表情,”unknown,poker-faced,happy,surprised,disgusted,sad,angry,contemptuous,panic,all”,未知,中性,高兴,惊讶,厌恶,难过,愤怒,轻蔑,害怕,全部

可选

gender

string

性别,”unknown,female,male,all”,未知,女人,男人,全部

可选

mask

string

口罩,”unknown,yes,no,all”,未知,戴口罩,不戴口罩,全部

可选

ageGroup

string

年龄段,”unknown,child,young,middle,old,infant,kid,teenager,prime,middleAged,all”,未知,少年(10-20),青年(30-40),中年(50-60),老年(70-),婴幼儿,儿童(0-10),青少年(20-30),壮年(40-50),中老年(60-70),全部

可选

glass

string

眼镜,”unknown,yes,no,sunglasses,all”,未知,戴眼镜,不戴眼镜,戴墨镜,全部

可选

regionId

string

区域ID,复选时,逗号隔开,支持多区域

必需

示例

返回响应

🟢200成功

application/json

Body

code

integer

返回码

必需

message

string

返回信息

必需

data

array [object {11}]

返回数据对象

可选

timeSpan

object

时间区间

可选

enterCount

integer

进入人数总数

必需

exitCount

integer

离开人数总数

必需

peoplePassingCount

integer

经过人数总数

可选

duplicatePeopleCount

integer

重复人数总

可选

faceExpressionList

array [object {2}]

人脸表情统计

可选

genderList

array [object {2}]

性别统计

可选

maskList

array [object {2}]

口罩统计

可选

ageGroupList

array [object {2}]

年龄段统计

可选

glassList

array [object {2}]

眼镜统计

可选

regionList

array [object {3}]

区域统计信息,支持多区域,分区域返回

可选

修改于 2022-05-25 09:52:50

客流统计参数配置获取

对接指南