TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixGoalApi

The Helix API methods that deal with creator goals.

Overview

Methods

Can be accessed using client.goals on an ApiClient instance.

Example

const api = new ApiClient({ authProvider });
const { data: goals } = await api.helix.goals.getGoals('61369223');

@meta category helix
@meta categorizedTitle Goals

Methods

getGoals(broadcaster)

async
ParameterTypeRequiredDefaultDescription
broadcaster
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

nonenone
Return type: HelixGoal[]