Skip to main content
GET
Get user-specific settings

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.

Response

User settings retrieved successfully

time_between_check
object

Time intervals between checks

email_notifications
object

User email notification preferences

global_ignore_text
string[]

Text patterns to ignore in change detection across all watches. Supports plain text and /regex/ patterns.

Maximum array length: 100
Maximum string length: 5000
global_subtractive_selectors
string[]

CSS/XPath selectors to remove content from all watched pages before comparison.

Maximum array length: 100
Maximum string length: 5000
noise_reduction_timestamps
boolean

When enabled, automatically ignores timestamp-like text changes (e.g. "3 minutes ago", "1.2k views") across all watches.

noise_reduction_ads
boolean

When enabled, automatically removes ad elements, cookie banners, and newsletter popups from all watched pages using community-maintained filter lists (EasyList + Fanboy's Cookie List).

ai_provider
enum<string>

The user's selected AI provider for change summaries and smart alerts.

Available options:
anthropic,
openai,
google,
ai_api_key_set
boolean

Whether the user has an AI API key configured.

ai_api_key_masked
string

Masked version of the AI API key for display.

anthropic_api_key_set
boolean

(Deprecated) Whether the user has an Anthropic API key configured.

anthropic_api_key_masked
string

(Deprecated) Masked version of the Anthropic API key.