Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get User Emotes Documentation Issues #921

Open
Nerixyz opened this issue Mar 9, 2024 · 1 comment
Open

Get User Emotes Documentation Issues #921

Nerixyz opened this issue Mar 9, 2024 · 1 comment
Labels
product: docs Documentation on dev.twitch.tv/docs

Comments

@Nerixyz
Copy link

Nerixyz commented Mar 9, 2024

Brief description

While implementing support for the Get User Emotes endpoint in Chatterino, I noticed some shortcomings in the documentation of the response.

  • data.name has the wrong documentation (currently: "The User ID of broadcaster whose channel is receiving the unban request.")
  • data.emote_type doesn't list all possible values, but the phrasing implies all possible values are listed. (Resolved in Impossible emote_type example for new get user emotes endpoint #928)
  • data.emote_set_id doesn't mention that it might be empty and why it could be empty.
  • data.owner_id doesn't mention that it might be empty and why it could be empty.

Expected documentation

  • data.name: The name of the emote. This is the name that viewers type in the chat window to get the emote to appear.
  • data.emote_type: The type of emote. Some possible values are: bitstier, follower, subscriptions, globals.
  • data.emote_set_id: An ID that identifies the emote set that the emote belongs to. Empty if ...
  • data.owner_id: The ID of the broadcaster who owns the emote. Empty if ...

Screenshots

firefox_2024-03-09_10-40-12

Additional context or questions

While implementing, I also noticed that the endpoint requires quite a lot of requests. For my user with two subscriptions, I had to make 28 requests to get all emotes for one channel. There are users with a lot more subs and a lot of channels open (25-100) which would - assuming 30 requests for one channel - make up to 3000 requests just starting the app. Most pages are sparsely populated, I got the following page sizes:

  • 4
  • 20x 5
  • 9
  • 10
  • 16
  • 21
  • 46
  • 47
  • 268

These could easily fit into 2–4 pages.

Should I open a separate issue for this?

@Nerixyz Nerixyz added the product: docs Documentation on dev.twitch.tv/docs label Mar 9, 2024
@Nerixyz Nerixyz changed the title _Get User Emotes_ Documentation Issues Get User Emotes Documentation Issues Mar 9, 2024
@BarryCarlyon
Copy link
Contributor

These could easily fit into 2–4 pages.
Should I open a separate issue for this?

Not a bug with helix is what I was told when I asked about it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: docs Documentation on dev.twitch.tv/docs
Projects
None yet
Development

No branches or pull requests

2 participants