clearFrequencyCapHistory

Clear stored frequency-cap histories. Clearing state does not automatically request another ad.

Example

const htag = window.htag.api('1');

htag.clearFrequencyCapHistory({ capIds: ['interstitial'] });
htag.refreshAds({ elementIds: ['interstitial-slot'] });

Call without arguments to clear every currently configured cap:

window.htag.api('1').clearFrequencyCapHistory();

Parameters

• options.capIds (optional): Cap IDs to clear. If omitted, all configured cap histories are cleared.

Return Value

Returns the Htag API object, allowing for method chaining.

Related Methods

• setFrequencyCaps: Configure placement or label-targeted frequency caps
• getFrequencyCapState: Inspect current cap histories and blocking state
• refreshAds: Request ads after clearing cap state