@mkterswingman/5mghost-twinkler 0.1.11 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mkterswingman/5mghost-twinkler",
3
- "version": "0.1.11",
3
+ "version": "0.1.12",
4
4
  "description": "Lightweight AI helper for the 5mghost Twinkler API",
5
5
  "type": "module",
6
6
  "engines": {
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  name: use-5mghost-twinkler
3
3
  preamble-tier: 3
4
- version: 0.4.0
4
+ version: 0.4.1
5
5
  description: |
6
6
  Use when the user wants Twitch streamer, game, ranking, stream-session, CCV,
7
7
  chat, live-watch, or SullyGnome data through the mkterswingman Twinkler API.
@@ -122,6 +122,26 @@ Pick the smallest API that answers the question:
122
122
  - Do not use `/search/advanced`; it intentionally returns 501 and is not part
123
123
  of the public-ready supported surface.
124
124
 
125
+ ### Channel Period Metrics
126
+
127
+ For channel-level metrics over a time window such as "30-day average CCV",
128
+ "90-day highest/peak CCV", "XX 天最高 CCV", "XX 天平均 CCV", stream hours,
129
+ watched hours, or stream count, use:
130
+
131
+ ```bash
132
+ twinkler call GET /api/v1/channel/<login>/summary --query days=<7|14|30|90|180|365>
133
+ ```
134
+
135
+ Report the matching summary fields directly, for example `average_viewers` for
136
+ average CCV and `peak_viewers` for highest/peak CCV. Do not calculate these
137
+ channel-level period metrics from `/channel/{name}/games`, `/streams`, or
138
+ stream game splits unless the user explicitly asks for a custom calculation and
139
+ you label it as custom.
140
+
141
+ Use `/channel/{name}/games` only for game-level breakdowns: which games the
142
+ channel streamed, per-game hours, or per-game viewer contribution. A single
143
+ game row's peak or average is not the channel's period-level peak or average.
144
+
125
145
  ## Watch Job Layer
126
146
 
127
147
  Use watch jobs when the user asks to monitor a live channel, collect CCV points,