Skip to content

Commit

Permalink
chore: clarify that "goals" are the same as "metrics" (#244)
Browse files Browse the repository at this point in the history
We got feedback from a customer that they were confused by the "goals"
language in our SDK docs, which we now call "metrics." This clarifies
that goals = metrics and A/B testing = Experimentation.

Story details: https://app.shortcut.com/launchdarkly/story/213100
  • Loading branch information
ember-stevens authored Aug 23, 2023
2 parents 36eb906 + 2eaf109 commit 9c1647f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/shared/sdk-server/src/api/LDClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -178,17 +178,17 @@ export interface LDClient {
/**
* Tracks that a context performed an event.
*
* LaunchDarkly automatically tracks pageviews and clicks that are specified in the Goals section
* of the dashboard. This can be used to track custom goals or other events that do not currently
* have goals.
* LaunchDarkly automatically tracks pageviews and clicks that are specified in the Metrics section
* of the dashboard. This can be used to track custom metrics (goals) or other events that do not currently
* have metrics.
*
* Note that event delivery is asynchronous, so the event may not actually be sent until later;
* see {@link flush}.
*
* If the context is omitted or has no key, the client will log a warning and will not send an
* event.
*
* @param key The name of the event, which may correspond to a goal in A/B tests.
* @param key The name of the event, which may correspond to a metric in Experimentation.
* @param context The context to track.
* @param data Optional additional information to associate with the event.
* @param metricValue A numeric value used by the LaunchDarkly experimentation feature in numeric
Expand Down

0 comments on commit 9c1647f

Please sign in to comment.