Home > widget-integration > CountdownTimerAPIResponse

CountdownTimerAPIResponse interface

API response shape from GET /bc-sf-filter/countdown-timer.

Signature:

export interface CountdownTimerAPIResponse 

Remarks

data is null when no active campaign matches the requested scope, the campaign has expired, or the store has no enabled countdown timers.

Properties

Property

Modifiers

Type

Description

data

CountdownCampaign | null

timer_scope

CountdownPlacement