Interface: PerformanceClient

Properties

context

protected readonly context: ClientContext

Methods

chart()

chart(period, options?, signal?): Promise<PerformanceChartResponse>

Omitted or empty accountIds include all accounts.

Parameters

period

"TODAY" | "ONE_WEEK" | "ONE_MONTH" | "THREE_MONTHS" | "THIS_YEAR" | "ONE_YEAR" | "THREE_YEARS" | "FIVE_YEARS" | "ALL_TIME" | PerformanceDateRange

options?

PerformanceChartOptions = {}

signal?

AbortSignal

Returns

Promise<PerformanceChartResponse>

---

insights()

insights(timePeriod, ids?, signal?): Promise<InsightsReport>

Omitted or empty accountIds include all accounts.

Parameters

timePeriod

"TODAY" | "ONE_WEEK" | "THIS_YEAR" | "THREE_YEARS_ROLLING"

ids?

readonly string[]

signal?

AbortSignal

Returns

Promise<InsightsReport>

---

totalValues()

totalValues(ids?, signal?): Promise<TotalValuesResponse>

Omitted or empty ids include all accounts.

Parameters

ids?

readonly string[]

signal?

AbortSignal

Returns

Promise<TotalValuesResponse>