Skip to content

@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiOperationResponseRateLimitInformation

Class: AffiliateApiOperationResponseRateLimitInformation

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiOperationResponseRateLimitInformation

An object containing information about the rate limit of an Affiliate API operation.

Accessors

asJson

get asJson(): Object

Returns the rate limit information as a JSON object.

Returns

Object

NameType
limitnumber
remainingnumber
usednumber
utilizationnumber

limit: number

-


remaining: number

-


used: number

-


utilization: number

-


Defined in

src/clients/affiliateApi/utils.ts:119


limit

get limit(): number

The maximum number of requests that can be made in the current time window.

Returns

number

Defined in

src/clients/affiliateApi/utils.ts:91


remaining

get remaining(): number

The number of requests remaining in the current time window.

Returns

number

Defined in

src/clients/affiliateApi/utils.ts:98


used

get used(): number

The number of requests that have been used in the current time window.

Returns

number

Defined in

src/clients/affiliateApi/utils.ts:105


utilization

get utilization(): number

The percentage of the rate limit that has been used.

Returns

number

Defined in

src/clients/affiliateApi/utils.ts:112