全部产品

阿里云Vlog数据服务API

开发者可以基于此API查询Vlog的运行统计数据,用以展示或分析。

1、服务介

1.1 产品简介

阿里云Vlog:以游客为中心,提供含智能采集,智能生产,智能分发的一站式解决方案,可实现在在采集点拍摄后,自动生成“人+景”的Vlog短视频。

1.2 产品组成

Vlog产品组成

阿里云Vlog包含三大核心基础设施:

1)智能采集,拍摄游客最美瞬间,解锁旅程中的“高光”时刻,提升分享意愿。

2)智能生产,汇集片段优选、自动生产、视觉特效等AI能力的一体机,实现秒级生成。

3)智能分发,通过“取Vlog机”一键下载短视频,抓住用户分享的黄金瞬间。

1.3 服务说明

本服务仅适用于已部署上述阿里云Vlog基础设施的场景,开发者可以基于此API查询Vlog的运行统计数据,用以展示或分析。

API 名称

API 描述

使用场景

path

离线统计查询

查询离线统计数据,包括游客、景点信息等

查询vlog使用的相关离线统计数据

/vlog/open/statistics/list

特别声明:本API仅有统计类事件数据,用以产品运行效能监测和优化分析,不涉及任何个体数据。

2、接口说明

2.1 服务开通及秘钥获取

本服务需完成以下前置准备:

1)准备一个认证完成的阿里云账号,如果没有阿里云账号,可访问链接进行注册。

2)登陆数字商业引擎平台,按照流程填写信息并申请入驻,审批通过后进行下一步操作。

3)创建景区实例,作为景区之间的隔离维度,比如一个景区创建一个实例,一个数字商业引擎可管理多个实例。

第一步:填写景区信息。创建项目

第二步:添加“阿里云Vlog”服务。添加能力

4)能力开通后即可按照步骤激活部署阿里云Vlog基础设施。

激活流程

5)基础设施激活后,可通过实例总览页右方的秘钥调用本服务。

秘钥

2.2 接入方式

SDK依赖请参考API调用对接指引

2.3 接口说明

实际调用前,请务必保证现场已经有Vlog基础设施在运行。

API定义

path

说明

版本

/vlog/open/statistics/list

离线统计查询

1.0.0

请求参数

属性

类型

是否必填

说明

projectId

String

项目id

cameraId

String

查询摄像头的客流时,必须填写该字段(摄像头列表不需要该字段)

modelId

String

模型id,区分具体返回什么内容,参看请求对应列表

paramJson

JSON

时间段,[startTime. endTime),包含startTime,不包含endTime

(查询摄像头列表时不做格式限制,随意)

-startTime

String

开始时间

格式:“2020121802”表示查询2020年12月18日02:00:00开始的数据(严格按照该格式填写yymmddhh,长度10)

-endTime

String

结束时间

格式:“2020121802”表示查询2020年12月18日02:00:00截止的数据(严格按照该格式填写yymmddhh,长度10)

(endTime > startTime)

  • 说明:

    • 当startTime和endTime相差小于等于24小时,返回查询中每个小时的数据列表;

    • 当startTime和endTime相差大于24小时,返回当前查询中每天(全天)的数据列表。

    • 查询项目摄像头列表时,paramJson保持格式一致,取值随意。

  • 具体日期格式如下,根据格式不同查询不同内容——趋势(时间段)、小时(小时级)

“paramJson”:{  // 时间差<=24小时,
               // 小时级,
               // 代表查询12月18日中22:00:00到12月19日中01:59:59之间的每个小时的数据
            "startTime":"2020121822",
            "endTime":"2020121902"    
    }

“paramJson”:{  // 时间差>24小时,
               // 指定时间段,
               // 代表查询12月18日(包含18)到12月19日(不包含19)的全天数据,即返回12月18日当天数据
            "startTime":"2020121802",
            "endTime":"2020121904"    
    }

返回值

属性

子属性

类型

说明

id

String

request id

code

int

错误码,成功时返回200

message

String

错误描述,成功时返回"success"

localizedMsg

String

本地语言错误消息

data

JSON

series

JSONArray

结果数据集合,每个JSON元素代表一系列数据

-name

String

结果数据系列名称

-values

JSONArray

结果数据系列值

请求列表数据

列出不同modelId对应的返回内容,具体返回参看“调用示例”

modelId

说明

IOTXAI_VLOG_PROJECT_REALTIME_STAT

项目流量概览

IOTXAI_VLOG_PROJECT_CAMERA_LIST

项目摄像头列表

IOTXAI_VLOG_CAMERA_TOURIST_OVERVIEW

单摄像头客流统计

3、调用示例

3.1 项目流量概览

请求示例

{
    "projectId":"a1240oTzoxy5QFFO",
    "modelId":"IOTXAI_VLOG_PROJECT_REALTIME_STAT",
    "paramJson": {
                "startTime": "2020121100",
                "endTime": "2020121301"    // 查询2020年12月11日(包含)-12月13(不包含)的数据
    },
    "version":"1.0.0"
}

返回示例

{
    "id":"246da69e-40ad-4f44-955e-ac880f9867d8",
    "code":200,
    "message":"success",
    "localizedMsg":"success",
    "data":{
            "series":[
            {
                    "name":"date",  // 日期
                    "values":[
                        "20201211",
                    "20201212"
                    ]
            },
            {
                    "name":"touristNum",  // 游客数量
                    "values":[
                        "402",
                    "150"
                    ]
            },
            {
                    "name":"appUerUV",    // 小程序访问人数UV
                    "values":[
                        "163",
                    "27"
                    ]
            },
            {
                    "name":"generateNumUV",   // 生成视频人数UV
                    "values":[
                        "73",   
                    "1"
                    ]
            },
            {
                    "name":"playNumUV",    // 观看人数UV
                    "values":[
                        "72",
                    "0"
                    ]
            },
            {
                    "name":"downloadNumUV",  // 下载人数点击UV
                    "values":[
                        "54",
                    "0"
                    ]
            },
            {
                    "name":"paidNumUV",  // 支付人数
                    "values":[
                        "0",
                    "0"
                    ]
            },
            {
                    "name":"shareNum",  // 分享人数
                    "values":[
                        "43",   
                    "0"
                    ]
            },
            {
                    "name":"appUserPV",  // 小程序打开次数PV
                    "values":[
                        "435",
                    "51"
                    ]
            },
            {
                    "name":"generateNumPV",  // 生成视频量PV
                    "values":[
                        "137",
                    "1"
                    ]
            },
            {
                    "name":"playNumPV",  // 观看次数PV
                    "values":[
                        "363",
                    "7"
                    ]
            },
            {
                    "name":"downloadNumPV",  // 下载次数PV
                    "values":[
                        "94",
                    "0"
                    ]
            },
            {
                    "name":"paidOrderNum",  // 支付笔数
                    "values":[
                        "0",
                    "0"
                    ]
            }
        ]
        }
}

3.2 项目摄像头列表

请求示例

{
    "projectId":"a1240oTzoxy5QFFO",
    "modelId":"IOTXAI_VLOG_PROJECT_CAMERA_LIST",
    “paramJson”:{    // 查询摄像头列表,paramJson格式保持一致、取值随意
            "startTime": "2020121802",
                    "endTime": "2020121803"
    }
    "version":"1.0.0"
}

返回示例

{
    "id":"246da69e-40ad-4f44-955e-ac880f9867d8",
    "code":200,
    "message":"success",
    "localizedMsg":"success",
    "data":{
            "series":[
            {
                    "name":"cameraId",  // 摄像头iot_id
                    "values":[
                        "2HtXcZGqgPfMbNiX4HxW", "F4FXcZG4kdYbNiX423g", "F4FXcZGqgPfMbNasdf34g"
                    ]
            }
        ]
        }
}

3.3 单摄像头客流统计

请求示例

{
    "projectId":"a1240oTzoxy5QFFO",
    "modelId":"IOTXAI_VLOG_CAMERA_TOURIST_OVERVIEW",
    "cameraId":"2HtXcZGqgPfMbNiX4HxW",
    “paramJson”:{
            "startTime": "2020121802",
                    "endTime": "2020121804"    // 查询2020年12月18日02:00:00到03:59:59的数据
    },
    "version":"1.0.0"
}

返回示例

{
    "id":"246da69e-40ad-4f44-955e-ac880f9867d8",
    "code":200,
    "message":"success",
    "localizedMsg":"success",
    "data":{
            "series":[
            {
                    "name":"date",  //  日期

                    "values":[
                        "2020121802",
                    "2020121803"
                    ]
            },
            {
                    "name":"touristsNum",    // 游客数量
                    "values":[
                        "453",
                    "234"
                    ]
            }
        ]
        }
}