@mkterswingman/5mghost-twinkler 0.1.11 → 0.1.13
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,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: use-5mghost-twinkler
|
|
3
3
|
preamble-tier: 3
|
|
4
|
-
version: 0.4.
|
|
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.
|
|
@@ -57,6 +57,9 @@ missing and not inferable from context:
|
|
|
57
57
|
game/category constraints.
|
|
58
58
|
- Ordering: `watched`, `avgviewers`, `peakviewers`, `streamtime`,
|
|
59
59
|
`mostfollowers`, `followergrowth`, or "latest streams".
|
|
60
|
+
- Timezone: required when reporting stream start/end times. If the user does
|
|
61
|
+
not specify one, default to `UTC+8` / `Asia/Shanghai` and say that briefly.
|
|
62
|
+
Always use the response `data.timezone` declaration when displaying times.
|
|
60
63
|
|
|
61
64
|
Use these defaults only for low-risk exploratory asks, and say them briefly in
|
|
62
65
|
the answer: `days=30`, `language=any`, `mature=include`, `page_size=25`.
|
|
@@ -97,7 +100,7 @@ Use `twinkler call` for one-off hosted API requests:
|
|
|
97
100
|
|
|
98
101
|
```bash
|
|
99
102
|
twinkler call GET /api/v1/channel/ibai/summary --query days=30
|
|
100
|
-
twinkler call GET /api/v1/channel/ibai/streams --query days=30 --query sort_by=avgviewers --query page=1 --query page_size=25
|
|
103
|
+
twinkler call GET /api/v1/channel/ibai/streams --query days=30 --query sort_by=avgviewers --query page=1 --query page_size=25 --query timezone=UTC+8
|
|
101
104
|
twinkler call GET /api/v1/search --query 'q=Delta Force'
|
|
102
105
|
twinkler call GET /api/v1/game/<selected_sullygnome_game_id>/channels --query days=365 --query sort_by=watched --query page=1 --query page_size=50
|
|
103
106
|
twinkler call GET /api/v1/rankings/channels --query sort_by=mostfollowers --query days=30 --query page=1 --query page_size=25
|
|
@@ -111,7 +114,10 @@ candidates.
|
|
|
111
114
|
Pick the smallest API that answers the question:
|
|
112
115
|
|
|
113
116
|
- Channel profile/current history: `/channel/{name}/summary`.
|
|
114
|
-
- A channel's recent broadcasts: `/channel/{name}/streams
|
|
117
|
+
- A channel's recent broadcasts: `/channel/{name}/streams`; include
|
|
118
|
+
`timezone=<user choice>` when stream start/end times will be shown. The route
|
|
119
|
+
defaults to `UTC+8` and returns `data.timezone`, plus row-level `start_time`
|
|
120
|
+
and `end_time` converted from the upstream UTC `startDateTime`.
|
|
115
121
|
- A channel's games: `/channel/{name}/games`.
|
|
116
122
|
- Stream-session chart or game splits: `/channel/{name}/stream/{stream_id}/chart`
|
|
117
123
|
and `/games`.
|
|
@@ -122,6 +128,26 @@ Pick the smallest API that answers the question:
|
|
|
122
128
|
- Do not use `/search/advanced`; it intentionally returns 501 and is not part
|
|
123
129
|
of the public-ready supported surface.
|
|
124
130
|
|
|
131
|
+
### Channel Period Metrics
|
|
132
|
+
|
|
133
|
+
For channel-level metrics over a time window such as "30-day average CCV",
|
|
134
|
+
"90-day highest/peak CCV", "XX 天最高 CCV", "XX 天平均 CCV", stream hours,
|
|
135
|
+
watched hours, or stream count, use:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
twinkler call GET /api/v1/channel/<login>/summary --query days=<7|14|30|90|180|365>
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Report the matching summary fields directly, for example `average_viewers` for
|
|
142
|
+
average CCV and `peak_viewers` for highest/peak CCV. Do not calculate these
|
|
143
|
+
channel-level period metrics from `/channel/{name}/games`, `/streams`, or
|
|
144
|
+
stream game splits unless the user explicitly asks for a custom calculation and
|
|
145
|
+
you label it as custom.
|
|
146
|
+
|
|
147
|
+
Use `/channel/{name}/games` only for game-level breakdowns: which games the
|
|
148
|
+
channel streamed, per-game hours, or per-game viewer contribution. A single
|
|
149
|
+
game row's peak or average is not the channel's period-level peak or average.
|
|
150
|
+
|
|
125
151
|
## Watch Job Layer
|
|
126
152
|
|
|
127
153
|
Use watch jobs when the user asks to monitor a live channel, collect CCV points,
|