> ## Documentation Index
> Fetch the complete documentation index at: https://docs.videowise.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Analytics

> Retrieve live shopping performance for a show by live stream ID.

## Base URL

`https://api.videowise.com`

All analytics endpoints require [authentication](/product-api/authentication). Rate limit: 100 requests per minute.

***

### Live shopping performance by lsId

#### **GET** `/external/analytics/v1/live-streams/:lsId`

Returns show metadata, host, and the six main live shopping KPIs, aggregated across live, replay, and referral channels.

#### Headers

| Key                        | Type   | Required | Description                                         |
| -------------------------- | ------ | -------- | --------------------------------------------------- |
| `X-Videowise-Access-Token` | String | Yes      | Store license key. Same token as Product and Media. |

#### Path parameters

| Key    | Type   | Required | Description     |
| ------ | ------ | -------- | --------------- |
| `lsId` | String | Yes      | Live stream ID. |

#### Example request

```bash theme={null}
curl -X GET "https://api.videowise.com/external/analytics/v1/live-streams/<lsId>" \
  -H "X-Videowise-Access-Token: <your_access_token>"
```

#### Example response

```json theme={null}
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Fall show",
  "startedAt": "2026-09-21T12:00:00.000Z",
  "endedAt": "2026-09-21T13:05:00.000Z",
  "durationSeconds": 3900,
  "host": {
    "name": "Jane Host",
    "email": "jane@example.com"
  },
  "kpis": {
    "sales": { "live": 10, "replay": 5, "total": 17 },
    "orders": { "live": 3, "replay": 1, "total": 6 },
    "viewers": { "live": 100, "replay": 40, "total": 140 },
    "addToCart": { "live": 12, "replay": 8, "avg": 10 },
    "avgViewTime": { "live": 60, "replay": 30, "avg": 45 },
    "devices": [
      { "device": "mobile", "value": 70 },
      { "device": "desktop", "value": 25 },
      { "device": "unknown", "value": 5 }
    ]
  }
}
```

| Field                        | Description                                                                  |
| ---------------------------- | ---------------------------------------------------------------------------- |
| `startedAt`                  | Show start time.                                                             |
| `endedAt`                    | Start plus duration for ended/archived shows. `null` while the show is live. |
| `host`                       | Host name and email when a host owner is set. Otherwise `null`.              |
| `kpis.sales` / `kpis.orders` | Live, replay, and `total` (live + replay + referral channels).               |
| `kpis.viewers`               | Distinct viewers, live + replay.                                             |
| `kpis.addToCart`             | Add-to-cart rate (%).                                                        |
| `kpis.avgViewTime`           | Average view time in seconds.                                                |
| `kpis.devices`               | Device share (%).                                                            |

#### Response

| Status | Description                                                 |
| ------ | ----------------------------------------------------------- |
| `200`  | Analytics for the show.                                     |
| `401`  | Missing or invalid access token.                            |
| `404`  | Live stream not found, or it does not belong to this store. |

## Related

* [Authentication](/product-api/authentication)
* [API overview](/product-api/overview)