获取视频分享数据

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

该接口用于获取视频分享数据。


注意事项

  • 用户首次授权应用后,需要第二天才会产生全部的数据;后续的数据会在第二天十点左右刷新。
  • 注意参数中 item_id 作为 url 参数时,必须 encode,只对 item_id 单独进行 encode。
  • 三十天内创建的视频,才会返回数据。

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/apps/v1/item/get_share/
HTTP Method
GET
Scope
ma.item.data
权限要求
  • 需要申请权限。需通过控制台-小程序应用下,进入“能力-用户数据能力-抖音账号数据”,申请"近30天视频数据查询"能力权限
  • 抖音用户通过小程序tt.showDouyinOpenAuth完成授权,调用/oauth/access_token/ 生成token。示例:act.xxx

请求头

名称字段类型是否必填示例描述
access-tokenStringact.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
date_typeInt64
近7/15天;输入7代表7天、15代表15天
item_idString
item_id,仅能查询access_token对应用户上传的视频

该字段通过 /api/apps/v1/convert_video_id/video_id_to_open_item_id/ 接口返回的 data.convert_result._val 字段获取

open_idStringba253642-0590-40bc-9bdf-9a1334b94059

通过code2Session获取,用户唯一标志

该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取

请求示例

curl --location --request GET 'https://open.douyin.com/api/apps/v1/item/get_share/?open_id=ba253642-0590-40bc-9bdf-9a1334b94059&item_id=&date_type=7' \
--header 'access-token: act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27L56lr' \ 

响应参数

Body

名称字段类型是否必填示例描述
err_msgString"access_token无效"
错误描述
err_noInt3228001003
错误码
log_idString"202405291440576E078D8757B9"
日志id

响应示例

正常响应示例

{
  "data": {
    "extra": {
      "error_code": 0,
      "description": "",
      "sub_error_code": 0,
      "sub_description": "",
      "logid": "202008121419360101980821035705926A",
      "now": 1597213176393
    },
    "data": {
      "result_list": [
        {
          "date": "yyyy-MM-dd",
          "share": 200
        }
      ]
    }
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "202008121419360101980821035705926A"
}

异常响应示例

{
  "data": {
    "extra": {
      "error_code": 2100005,
      "description": "Parameter error",
      "sub_error_code": 0,
      "sub_description": "",
      "now": 1594015876138,
      "log_id": "2020070614111601022506808001045D59"
    }
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "2020070614111601022506808001045D59"
}

错误码

http状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常