issues
issues copied to clipboard
Get Broadcaster Subscriptions clarity when providing user_ids
Brief description
Get Broadcaster Subscriptions does not provide total or points when user_ids parameter is provided.
The docs do not indicate that these fields are omitted in this use case. The clarity would be nice, especially for people who generate models in their code based on the docs.
Expected documentation
Explicitly state that the total and points fields are not provided when passing user_ids parameter.
Additional context or questions
curl -X GET "https://api.twitch.tv/helix/subscriptions?broadcaster_id=21734222" -H "Authorization: Bearer ..." -H "Client-Id: ..."{
"data": [
{
"broadcaster_id": "21734222",
"broadcaster_login": "chillymosh",
"broadcaster_name": "chillymosh",
"gifter_id": "",
"gifter_login": "",
"gifter_name": "",
"is_gift": false,
"plan_name": "Channel Subscription (chillymosh): $24.99 Sub",
"tier": "3000",
"user_id": "21734222",
"user_name": "chillymosh",
"user_login": "chillymosh"
}
],
"pagination": {
"cursor": ""
},
"points": 0,
"total": 0
}
curl -X GET "https://api.twitch.tv/helix/subscriptions?broadcaster_id=21734222&user_id=21734222" -H "Authorization: Bearer ..." -H "Client-Id: ..."{
"data": [
{
"broadcaster_id": "21734222",
"broadcaster_login": "chillymosh",
"broadcaster_name": "chillymosh",
"gifter_id": "",
"gifter_login": "",
"gifter_name": "",
"is_gift": false,
"plan_name": "Channel Subscription (chillymosh): $24.99 Sub",
"tier": "3000",
"user_id": "21734222",
"user_name": "chillymosh",
"user_login": "chillymosh"
}
]
}
Tracking this documentation update internally as DEVREL-238.