# 查询观看数据概览

**POST /api/v1/open/watch-data/overview**

查询活动注册／匿名观众数、会话数及有效观看秒数。

## 使用场景

查询一个活动的总体观看情况，分别返回全部、注册和匿名观众的汇总。用于看板和数据同步；判断直播数据是否定稿时，同时检查 `dataState`。

## 请求参数

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `ticketCode` | string | 是 | 活动公开码，从商家控制台观看链接 /w/{ticketCode} 获取；不是活动 ID。 |
| `playbackMode` | string | 是 | ALL 全部、LIVE 直播、REPLAY 回放，必须显式传入。 |

## 返回值

| 字段 | 类型 | 始终返回 | 说明 |
|---|---|---|---|
| `requestId` | string | 是 | 请求追踪编号，排查问题时提供此值。 |
| `data` | object | 是 | 业务结果。 |
| `data.ticketCode` | string | 是 | 本次查询的活动公开码。 |
| `data.dataState` | string | 是 | PROVISIONAL 暂定、FINALIZING 最终化中、FINAL 达到当前模式的定稿条件。 |
| `data.dataUpdatedAt` | string | 否 | 汇总最近更新时间。 UTC RFC3339；无值时省略。 |
| `data.liveDataUpdatedAt` | string | 否 | 直播数据最近更新时间。 UTC RFC3339；无值时省略。 |
| `data.replayDataUpdatedAt` | string | 否 | 回放数据最近更新时间。 UTC RFC3339；无值时省略。 |
| `data.all` | object | 是 | 全部主体统计。 |
| `data.all.viewerCount` | integer | 是 | 观看主体数，ALL 暂定数据的计数限制见统计口径。 |
| `data.all.sessionCount` | integer | 是 | 该范围播放会话数，不等于观众数。 |
| `data.all.watchSeconds` | integer | 是 | 该范围累计有效观看秒数。 |
| `data.registered` | object | 是 | 注册主体统计。 |
| `data.registered.viewerCount` | integer | 是 | 观看主体数，ALL 暂定数据的计数限制见统计口径。 |
| `data.registered.sessionCount` | integer | 是 | 该范围播放会话数，不等于观众数。 |
| `data.registered.watchSeconds` | integer | 是 | 该范围累计有效观看秒数。 |
| `data.anonymous` | object | 是 | 匿名主体统计。 |
| `data.anonymous.viewerCount` | integer | 是 | 观看主体数，ALL 暂定数据的计数限制见统计口径。 |
| `data.anonymous.sessionCount` | integer | 是 | 该范围播放会话数，不等于观众数。 |
| `data.anonymous.watchSeconds` | integer | 是 | 该范围累计有效观看秒数。 |
| `data.liveWatchSeconds` | integer | 是 | 直播有效观看秒数，受 playbackMode 筛选。 |
| `data.replayWatchSeconds` | integer | 是 | 回放有效观看秒数，受 playbackMode 筛选。 |

```json
{
  "requestId": "req-example-003",
  "data": {
    "ticketCode": "demo-live",
    "dataState": "PROVISIONAL",
    "dataUpdatedAt": "2026-10-12T08:00:00Z",
    "liveDataUpdatedAt": "2026-10-12T07:50:00Z",
    "replayDataUpdatedAt": "2026-10-12T08:00:00Z",
    "all": { "viewerCount": 12, "sessionCount": 20, "watchSeconds": 7200 },
    "registered": { "viewerCount": 10, "sessionCount": 17, "watchSeconds": 6600 },
    "anonymous": { "viewerCount": 2, "sessionCount": 3, "watchSeconds": 600 },
    "liveWatchSeconds": 6000,
    "replayWatchSeconds": 1200
  }
}
```

## 统计口径

| 概念 | 说明 |
|---|---|
| `ALL`／`LIVE`／`REPLAY` | 分别统计全部／直播／回放；必须显式指定 |
| 注册观众 | 已识别的观众账户；匿名观众按系统匿名主体统计，不等同于自然人 |
| `viewerCount` | 范围内观看主体数；暂定的 ALL 概览可能将同一主体的直播与回放计数相加，不能直接当作跨模式去重人数 |
| `sessionCount` | 播放会话数，同一观众可能有多次会话 |
| `watchSeconds` | 服务端认定的有效观看秒数，不是页面打开时长，也不是活动持续时长 |
| 最近更新时间 | 数据处理时间；尚无对应时间时字段省略，不返回空字符串 |

直播未定稿时可能读取实时聚合，回放随观看持续更新。概览允许返回暂定数据；它不会因为直播明细未定稿就必然返回 `WATCH_DATA_NOT_FINAL`。

## 数据状态

| dataState | 如何使用 |
|---|---|
| `PROVISIONAL` | 当前仍是暂定数据，后续可能更新；REPLAY 查询始终按暂定数据处理，ALL 含回放数据时也如此 |
| `FINALIZING` | LIVE，或尚无回放数据的 ALL，活动已结束／取消／失败，直播汇总正在最终化 |
| `FINAL` | 已达到当前查询模式的直播定稿条件；不能据此断言回放数据永久不变 |

需要结算直播数据时，使用 `LIVE` 并等待 `FINAL`。本接口返回概览，不提供所有观众的逐条记录；注册观众明细使用[观看明细接口](/api/watch-viewers.md)。

## 相关错误

| HTTP | error.code | 处理方式 |
|---|---|---|
| 400 | `REQUEST_INVALID` | 检查是否显式传入合法 playbackMode |
| 404 | `WEBINAR_NOT_FOUND` | 检查入口码与所属商户 |
| 503 | `WATCH_DATA_UNAVAILABLE` | 汇总数据暂不可用，稍后查询 |

通用错误见[错误码与排查](/guide/errors.md)。

## 请求示例

### cURL

```sh
# 先设置 OPEN_API_BASE_URL、OPEN_API_KEY、OPEN_API_SECRET；请使用当前环境的凭证。
set -eu
: "${OPEN_API_BASE_URL:?请设置 HTTPS API Origin}"
: "${OPEN_API_KEY:?请设置 API Key}"
: "${OPEN_API_SECRET:?请设置 Secret}"
export OPEN_API_PATH='/api/v1/open/watch-data/overview'
export OPEN_API_BODY='{"ticketCode":"demo-live","playbackMode":"ALL"}'
export OPEN_API_TIMESTAMP="$(date +%s)"
export OPEN_API_NONCE="$(python3 -c 'import secrets; print(secrets.token_hex(16))')"
SIGNATURE="$(python3 - <<'PY'
import hashlib, hmac, os
body = os.environ['OPEN_API_BODY'].encode('utf-8')
canonical = '\n'.join([os.environ['OPEN_API_KEY'], 'POST', os.environ['OPEN_API_PATH'], os.environ['OPEN_API_TIMESTAMP'], os.environ['OPEN_API_NONCE'], hashlib.sha256(body).hexdigest()])
print(hmac.new(os.environ['OPEN_API_SECRET'].encode('utf-8'), canonical.encode('utf-8'), hashlib.sha256).hexdigest())
PY
)"
# 不使用 -v 或调试日志；响应可能含观众资料或一次性登录票据。
curl --silent --show-error --max-time 15 \
  --request POST "${OPEN_API_BASE_URL%/}${OPEN_API_PATH}" \
  --header 'Content-Type: application/json' \
  --header "X-API-Key: ${OPEN_API_KEY}" \
  --header "X-Timestamp: ${OPEN_API_TIMESTAMP}" \
  --header "X-Nonce: ${OPEN_API_NONCE}" \
  --header "X-Signature: ${SIGNATURE}" \
  --data-binary "${OPEN_API_BODY}"
```

### Java

```java
// Java 17+；只使用标准库。
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.SecureRandom;
import java.time.Duration;
import java.util.HexFormat;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

class OpenApiExample {
  private static String requiredEnv(String name) {
    String value = System.getenv(name);
    if (value == null || value.isBlank()) throw new IllegalArgumentException("请设置环境变量 " + name);
    return value;
  }

  public static void main(String[] args) throws Exception {
    String baseURL = requiredEnv("OPEN_API_BASE_URL").replaceFirst("/+$", "");
    String apiKey = requiredEnv("OPEN_API_KEY");
    String secret = requiredEnv("OPEN_API_SECRET");
    String path = "/api/v1/open/watch-data/overview";
    String rawBody = "{\"ticketCode\":\"demo-live\",\"playbackMode\":\"ALL\"}";
    byte[] bodyBytes = rawBody.getBytes(StandardCharsets.UTF_8);
    String timestamp = Long.toString(System.currentTimeMillis() / 1000);
    byte[] nonceBytes = new byte[16];
    new SecureRandom().nextBytes(nonceBytes);
    String nonce = HexFormat.of().formatHex(nonceBytes);
    String bodyHash = HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(bodyBytes));
    String canonical = String.join("\n", apiKey, "POST", path, timestamp, nonce, bodyHash);
    Mac mac = Mac.getInstance("HmacSHA256");
    mac.init(new SecretKeySpec(secret.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
    String signature = HexFormat.of().formatHex(mac.doFinal(canonical.getBytes(StandardCharsets.UTF_8)));

    HttpRequest request = HttpRequest.newBuilder(URI.create(baseURL + path))
        .timeout(Duration.ofSeconds(15))
        .header("Content-Type", "application/json")
        .header("X-API-Key", apiKey)
        .header("X-Timestamp", timestamp)
        .header("X-Nonce", nonce)
        .header("X-Signature", signature)
        .POST(HttpRequest.BodyPublishers.ofByteArray(bodyBytes))
        .build();
    HttpClient client = HttpClient.newBuilder()
        .connectTimeout(Duration.ofSeconds(15))
        .followRedirects(HttpClient.Redirect.NEVER)
        .build();
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
    // 仅在本地对接时查看完整响应；正式业务请用项目的 JSON 库解析，禁止记录完整观众资料或登录票据。
    System.out.printf("status=%d%n%s%n", response.statusCode(), response.body());
  }
}
```

### PHP

```php
<?php
// PHP 8.1+；需要 cURL 扩展，不依赖第三方包。
function required_env(string $name): string {
    $value = getenv($name);
    if ($value === false || $value === '') {
        throw new RuntimeException('请设置环境变量 ' . $name);
    }
    return $value;
}

$baseURL = rtrim(required_env('OPEN_API_BASE_URL'), '/');
$apiKey = required_env('OPEN_API_KEY');
$secret = required_env('OPEN_API_SECRET');
$path = '/api/v1/open/watch-data/overview';
$rawBody = '{"ticketCode":"demo-live","playbackMode":"ALL"}';
$timestamp = (string) time();
$nonce = bin2hex(random_bytes(16));
$bodyHash = hash('sha256', $rawBody);
$canonical = implode("\n", [$apiKey, 'POST', $path, $timestamp, $nonce, $bodyHash]);
$signature = hash_hmac('sha256', $canonical, $secret);

$curl = curl_init($baseURL . $path);
if ($curl === false) {
    throw new RuntimeException('无法初始化 cURL');
}
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $rawBody,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-API-Key: ' . $apiKey,
        'X-Timestamp: ' . $timestamp,
        'X-Nonce: ' . $nonce,
        'X-Signature: ' . $signature,
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_CONNECTTIMEOUT => 15,
    CURLOPT_TIMEOUT => 15,
]);
$responseBody = curl_exec($curl);
if ($responseBody === false) {
    $message = curl_error($curl);
    curl_close($curl);
    throw new RuntimeException('请求失败：' . $message);
}
$status = (int) curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
$result = json_decode($responseBody, true, 512, JSON_THROW_ON_ERROR);
// result['data'] 交给业务处理；不要记录完整响应和票据。
printf("status=%d requestId=%s errorCode=%s\n", $status, $result['requestId'] ?? '', $result['error']['code'] ?? '');
```

### Node.js

```mjs
// Node.js 22+；使用内置 fetch 和 crypto，无额外依赖。
import { createHash, createHmac, randomBytes } from 'node:crypto'
const { OPEN_API_BASE_URL: baseURL, OPEN_API_KEY: apiKey, OPEN_API_SECRET: secret } = process.env
if (!baseURL || !apiKey || !secret) throw new Error('请设置环境变量')
const path = '/api/v1/open/watch-data/overview'
const rawBody = "{\"ticketCode\":\"demo-live\",\"playbackMode\":\"ALL\"}"
const timestamp = String(Math.floor(Date.now() / 1000))
const nonce = randomBytes(16).toString('hex')
const bodyHash = createHash('sha256').update(rawBody, 'utf8').digest('hex')
const canonical = [apiKey, 'POST', path, timestamp, nonce, bodyHash].join('\n')
const signature = createHmac('sha256', secret).update(canonical, 'utf8').digest('hex')
const response = await fetch(baseURL.replace(/\/$/, '') + path, {
  method: 'POST', redirect: 'error', signal: AbortSignal.timeout(15000),
  headers: { 'Content-Type': 'application/json', 'X-API-Key': apiKey, 'X-Timestamp': timestamp, 'X-Nonce': nonce, 'X-Signature': signature },
  body: rawBody,
})
const result = await response.json()
// result.data 交给业务处理；不要将凭证、登录票据或完整观众资料写入日志。
console.log({ status: response.status, requestId: result.requestId, errorCode: result.error?.code })
```

### Python

```py
# Python 3.9+；只使用标准库。
import hashlib, hmac, json, os, secrets, time
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
base_url = os.environ['OPEN_API_BASE_URL'].rstrip('/')
api_key = os.environ['OPEN_API_KEY']
secret = os.environ['OPEN_API_SECRET']
path = '/api/v1/open/watch-data/overview'
raw_body = "{\"ticketCode\":\"demo-live\",\"playbackMode\":\"ALL\"}".encode('utf-8')
timestamp, nonce = str(int(time.time())), secrets.token_hex(16)
canonical = '\n'.join([api_key, 'POST', path, timestamp, nonce, hashlib.sha256(raw_body).hexdigest()])
signature = hmac.new(secret.encode('utf-8'), canonical.encode('utf-8'), hashlib.sha256).hexdigest()
request = Request(base_url + path, data=raw_body, method='POST', headers={
    'Content-Type': 'application/json', 'X-API-Key': api_key,
    'X-Timestamp': timestamp, 'X-Nonce': nonce, 'X-Signature': signature,
})
try:
    response = build_opener(NoRedirect).open(request, timeout=15)
except HTTPError as error:
    response = error
result = json.load(response)
# 将 result['data'] 交给业务处理；不要记录完整响应和票据。
print({'status': response.code, 'requestId': result.get('requestId'), 'errorCode': result.get('error', {}).get('code')})
```

### Go

```go
// Go 1.22+；只使用标准库。
package main
import (
  "bytes"
  "crypto/hmac"
  "crypto/rand"
  "crypto/sha256"
  "encoding/hex"
  "encoding/json"
  "fmt"
  "net/http"
  "os"
  "strconv"
  "strings"
  "time"
)
func main() {
  baseURL, apiKey, secret := os.Getenv("OPEN_API_BASE_URL"), os.Getenv("OPEN_API_KEY"), os.Getenv("OPEN_API_SECRET")
  if baseURL == "" || apiKey == "" || secret == "" { panic("请设置环境变量") }
  path := "/api/v1/open/watch-data/overview"
  rawBody := []byte("{\"ticketCode\":\"demo-live\",\"playbackMode\":\"ALL\"}")
  nonceBytes := make([]byte, 16)
  if _, err := rand.Read(nonceBytes); err != nil { panic("随机数生成失败") }
  timestamp, nonce := strconv.FormatInt(time.Now().Unix(), 10), hex.EncodeToString(nonceBytes)
  digest := sha256.Sum256(rawBody)
  canonical := strings.Join([]string{apiKey, "POST", path, timestamp, nonce, hex.EncodeToString(digest[:])}, "\n")
  mac := hmac.New(sha256.New, []byte(secret)); mac.Write([]byte(canonical))
  req, err := http.NewRequest("POST", strings.TrimRight(baseURL, "/") + path, bytes.NewReader(rawBody))
  if err != nil { panic("请求构建失败") }
  for name, value := range map[string]string{"Content-Type":"application/json", "X-API-Key":apiKey, "X-Timestamp":timestamp, "X-Nonce":nonce, "X-Signature":hex.EncodeToString(mac.Sum(nil))} { req.Header.Set(name,value) }
  client := &http.Client{Timeout:15*time.Second, CheckRedirect:func(_ *http.Request, _ []*http.Request) error { return http.ErrUseLastResponse }}
  resp, err := client.Do(req)
  if err != nil { panic("网络请求失败，请检查连接") }
  defer resp.Body.Close()
  var result map[string]any
  if err := json.NewDecoder(resp.Body).Decode(&result); err != nil { panic("响应不是 JSON") }
  // result["data"] 交给业务处理；只记录状态和请求编号。
  fmt.Printf("status=%d requestId=%v\n", resp.StatusCode, result["requestId"])
}
```