FeelingSurf API

• status string

{
    "status": "ok"
}

• id integer
  Unique identifier.
• username string
  Your username.
• plan string (premium)
  Membership plan. Always premium, since the API requires Premium.
• credits number
  Current credit balance.
• earning object
  Credits earned by surfing.
  • credits_today number
    Credits earned by surfing today.
  • credits_last_7_days number
    Rolling sum over the last 7 days (today inclusive).
• surfing object
  Your live surfing activity.
  • active_sessions integer
    FeelingSurfViewer sessions active in the last few minutes.
• site_slots object
  Site-slot usage; create returns 403 once used reaches max.
  • used integer
    Site slots currently in use (your number of sites).
  • max integer
    Total site slots your plan allows.
  • available integer
    Unused site slots (max minus used).
• visit_own_sites boolean
  Whether the app also surfs your own sites.
• timezone string nullable
  IANA timezone for active-hours scheduling; UTC is used when null.
• currency string (eur, usd)
  Your billing currency.
• language string (en, fr, es, pt, ru, vi, id, tr, de, it, nl)
  Your account language (ISO code).
• newsletter boolean
  Newsletter email opt-in.
• invoice_emails boolean
  Whether invoice emails are sent.
• subscription object
  Premium subscription lifecycle.
  • active boolean
    Whether an active premium subscription exists.
  • renews_at string nullable
    Next renewal date while active and not cancelled.
  • ends_at string nullable
    When premium access ends after a cancellation.

{
    "id": 98221,
    "username": "acme",
    "plan": "premium",
    "credits": 5000,
    "earning": {
        "credits_today": 0,
        "credits_last_7_days": 0
    },
    "surfing": {
        "active_sessions": 1
    },
    "site_slots": {
        "used": 1,
        "max": 12,
        "available": 11
    },
    "visit_own_sites": false,
    "timezone": null,
    "currency": "eur",
    "language": "en",
    "newsletter": true,
    "invoice_emails": true,
    "subscription": {
        "active": true,
        "renews_at": "2026-12-25T12:00:00Z",
        "ends_at": null
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• username string
  Your username.
• plan string (premium)
  Membership plan. Always premium, since the API requires Premium.
• credits number
  Current credit balance.
• earning object
  Credits earned by surfing.
  • credits_today number
    Credits earned by surfing today.
  • credits_last_7_days number
    Rolling sum over the last 7 days (today inclusive).
• surfing object
  Your live surfing activity.
  • active_sessions integer
    FeelingSurfViewer sessions active in the last few minutes.
• site_slots object
  Site-slot usage; create returns 403 once used reaches max.
  • used integer
    Site slots currently in use (your number of sites).
  • max integer
    Total site slots your plan allows.
  • available integer
    Unused site slots (max minus used).
• visit_own_sites boolean
  Whether the app also surfs your own sites.
• timezone string nullable
  IANA timezone for active-hours scheduling; UTC is used when null.
• currency string (eur, usd)
  Your billing currency.
• language string (en, fr, es, pt, ru, vi, id, tr, de, it, nl)
  Your account language (ISO code).
• newsletter boolean
  Newsletter email opt-in.
• invoice_emails boolean
  Whether invoice emails are sent.
• subscription object
  Premium subscription lifecycle.
  • active boolean
    Whether an active premium subscription exists.
  • renews_at string nullable
    Next renewal date while active and not cancelled.
  • ends_at string nullable
    When premium access ends after a cancellation.

{
    "id": 98221,
    "username": "acme",
    "plan": "premium",
    "credits": 5000,
    "earning": {
        "credits_today": 0,
        "credits_last_7_days": 0
    },
    "surfing": {
        "active_sessions": 1
    },
    "site_slots": {
        "used": 1,
        "max": 12,
        "available": 11
    },
    "visit_own_sites": false,
    "timezone": null,
    "currency": "eur",
    "language": "en",
    "newsletter": true,
    "invoice_emails": true,
    "subscription": {
        "active": true,
        "renews_at": "2026-12-25T12:00:00Z",
        "ends_at": null
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data SurfSession[]
  • ip_address string
    The IP address this session runs from.
  • country_code string nullable
    ISO country code of the IP, or null if unknown.
  • credits_earned number
    Credits this session has earned.
  • active boolean
    Whether the session was active in the last few minutes.
  • last_activity_at string nullable
    When the session was last active.
  • app_version string nullable
    FeelingSurfViewer app version, e.g. "2.5.0".
  • app_version_outdated boolean
    Whether this app version is behind the current release.
  • app_version_supported_until string nullable
    When support for this app version ends, or null.
  • low_quality_ip boolean
    The IP is classified low-quality (earns more slowly).
  • overused_ip boolean
    True when this IP has tripped one of your account's session limits — for example too many simultaneous sessions from the same IP or IP subnet, or your account-wide session cap. While flagged, further sessions from the IP are rejected, so it earns less until it drops back under the limit.
• meta PageMeta
  Pagination metadata for a list response.
  • limit integer
    Page size applied (clamped).
  • offset integer
    Number of items skipped before this page.
  • total integer
    Total number of items across all pages.

{
    "data": [
        {
            "ip_address": "203.0.113.42",
            "country_code": "US",
            "credits_earned": 128.5,
            "active": true,
            "last_activity_at": "2026-06-25T09:04:36Z",
            "app_version": "2.5.0",
            "app_version_outdated": false,
            "app_version_supported_until": null,
            "low_quality_ip": false,
            "overused_ip": false
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 1
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• referral_link string
  Shareable signup link that credits you for the referral.
• referred_count integer
  Number of (non-banned) users you referred.
• commission_percent integer
  Your referral commission: you get this percentage of every credit your referrals earn, forever (10 for Free accounts, 20 for Premium).
• credits_earned object
  Credits earned from referrals.
  • total number
    All-time commission credits.
  • today number
    Commission credits earned today.
  • last_7_days number
    Rolling sum over the last 7 days (today inclusive).

{
    "referral_link": "https://www.feelingsurf.fr/r/98220",
    "referred_count": 0,
    "commission_percent": 20,
    "credits_earned": {
        "total": 0,
        "today": 0,
        "last_7_days": 0
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data Site[]
  • id integer
    Unique identifier.
  • url string
    The website's URL.
  • name string nullable
    Optional user-chosen name.
  • paused boolean
    Whether the user has paused delivery.
  • blocked boolean
    Whether the platform has blocked the site (e.g. dead link).
  • limit_reached boolean
    Whether a configured visit cap has been reached.
  • devices object
    Device targeting split, as percentages summing to 100.
    • desktop integer (0–100)
      Percentage of visits sent to desktop devices.
    • mobile integer (0–100)
      Percentage of visits sent to mobile devices.
    • tablet integer (0–100)
      Percentage of visits sent to tablet devices.
  • visit_duration object
    Visit duration range, in seconds.
    • min_seconds integer (10–600)
      Shortest visit duration, in seconds.
    • max_seconds integer (10–600)
      Longest visit duration, in seconds.
  • visit_distribution string (even, asap)
    How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
  • limits object
    Visit caps; null means no limit.
    • hourly integer (1–500)
      Max visits per hour — always at least 1 (an hourly cap is mandatory).
    • daily integer nullable (1–10000)
      Max visits per day; null means no limit.
    • total integer nullable (1–500000)
      Max visits in total (lifetime); null means no limit.
  • schedule object
    Active-hours scheduling.
    • active_hours_mask string nullable
      A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
    • time_zone string nullable
      IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
  • traffic_quality object
    Traffic quality controls.
    • low_quality_ips boolean
      Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
    • ipv6 boolean
      Whether IPv6 visitors may deliver visits to this site.
  • browsing object
    Browsing options.
    • max_sub_windows integer (0–1)
      How many pop-up windows the visited site may open during a visit.
  • traffic_sources integer[]
    IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
  • labels integer[]
    IDs of assigned labels (resolve via GET /v1/labels).
  • total_visits integer
    Lifetime visits delivered.
  • created_at string nullable
    When it was created (UTC), or null.
• meta PageMeta
  Pagination metadata for a list response.
  • limit integer
    Page size applied (clamped).
  • offset integer
    Number of items skipped before this page.
  • total integer
    Total number of items across all pages.

{
    "data": [
        {
            "id": 2761880,
            "url": "https://example.com",
            "name": "My landing page",
            "paused": false,
            "blocked": false,
            "limit_reached": false,
            "devices": {
                "desktop": 100,
                "mobile": 0,
                "tablet": 0
            },
            "visit_duration": {
                "min_seconds": 10,
                "max_seconds": 10
            },
            "visit_distribution": "even",
            "limits": {
                "hourly": 50,
                "daily": null,
                "total": null
            },
            "schedule": {
                "active_hours_mask": null,
                "time_zone": null
            },
            "traffic_quality": {
                "low_quality_ips": true,
                "ipv6": true
            },
            "browsing": {
                "max_sub_windows": 0
            },
            "traffic_sources": [1],
            "labels": [],
            "total_visits": 0,
            "created_at": "2026-06-25T07:58:02Z"
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 1
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• url string
  The website's URL.
• name string nullable
  Optional user-chosen name.
• paused boolean
  Whether the user has paused delivery.
• blocked boolean
  Whether the platform has blocked the site (e.g. dead link).
• limit_reached boolean
  Whether a configured visit cap has been reached.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• labels integer[]
  IDs of assigned labels (resolve via GET /v1/labels).
• total_visits integer
  Lifetime visits delivered.
• created_at string nullable
  When it was created (UTC), or null.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• visit_history object
  Recent visit counts.
  • by_hour integer[]
    Visits per hour over the last 24h, oldest first (last = current hour).
  • by_day integer[]
    Visits per day over the last 8 days, oldest first (last = today).

{
    "id": 2761880,
    "url": "https://example.com",
    "name": "My landing page",
    "paused": false,
    "blocked": false,
    "limit_reached": false,
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "traffic_sources": [1],
    "labels": [],
    "total_visits": 0,
    "created_at": "2026-06-25T07:58:02Z",
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "visit_history": {
        "by_hour": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        "by_day": [0, 0, 0, 0, 0, 0, 0, 0]
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• url string
  The website's URL.
• name string nullable
  Optional user-chosen name.
• paused boolean
  Whether the user has paused delivery.
• blocked boolean
  Whether the platform has blocked the site (e.g. dead link).
• limit_reached boolean
  Whether a configured visit cap has been reached.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• labels integer[]
  IDs of assigned labels (resolve via GET /v1/labels).
• total_visits integer
  Lifetime visits delivered.
• created_at string nullable
  When it was created (UTC), or null.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• visit_history object
  Recent visit counts.
  • by_hour integer[]
    Visits per hour over the last 24h, oldest first (last = current hour).
  • by_day integer[]
    Visits per day over the last 8 days, oldest first (last = today).

{
    "id": 2761880,
    "url": "https://example.com",
    "name": "My landing page",
    "paused": false,
    "blocked": false,
    "limit_reached": false,
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "traffic_sources": [1],
    "labels": [],
    "total_visits": 0,
    "created_at": "2026-06-25T07:58:02Z",
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "visit_history": {
        "by_hour": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        "by_day": [0, 0, 0, 0, 0, 0, 0, 0]
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• url string
  The website's URL.
• name string nullable
  Optional user-chosen name.
• paused boolean
  Whether the user has paused delivery.
• blocked boolean
  Whether the platform has blocked the site (e.g. dead link).
• limit_reached boolean
  Whether a configured visit cap has been reached.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• labels integer[]
  IDs of assigned labels (resolve via GET /v1/labels).
• total_visits integer
  Lifetime visits delivered.
• created_at string nullable
  When it was created (UTC), or null.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• visit_history object
  Recent visit counts.
  • by_hour integer[]
    Visits per hour over the last 24h, oldest first (last = current hour).
  • by_day integer[]
    Visits per day over the last 8 days, oldest first (last = today).

{
    "id": 2761880,
    "url": "https://example.com",
    "name": "My landing page",
    "paused": false,
    "blocked": false,
    "limit_reached": false,
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "traffic_sources": [1],
    "labels": [],
    "total_visits": 0,
    "created_at": "2026-06-25T07:58:02Z",
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "visit_history": {
        "by_hour": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        "by_day": [0, 0, 0, 0, 0, 0, 0, 0]
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data SiteTemplate[]
  • id integer
    Unique identifier.
  • name string nullable
    Template name.
  • devices object
    Device targeting split, as percentages summing to 100.
    • desktop integer (0–100)
      Percentage of visits sent to desktop devices.
    • mobile integer (0–100)
      Percentage of visits sent to mobile devices.
    • tablet integer (0–100)
      Percentage of visits sent to tablet devices.
  • visit_duration object
    Visit duration range, in seconds.
    • min_seconds integer (10–600)
      Shortest visit duration, in seconds.
    • max_seconds integer (10–600)
      Longest visit duration, in seconds.
  • visit_distribution string (even, asap)
    How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
  • limits object
    Visit caps; null means no limit.
    • hourly integer (1–500)
      Max visits per hour — always at least 1 (an hourly cap is mandatory).
    • daily integer nullable (1–10000)
      Max visits per day; null means no limit.
    • total integer nullable (1–500000)
      Max visits in total (lifetime); null means no limit.
  • schedule object
    Active-hours scheduling.
    • active_hours_mask string nullable
      A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
    • time_zone string nullable
      IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
  • traffic_quality object
    Traffic quality controls.
    • low_quality_ips boolean
      Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
    • ipv6 boolean
      Whether IPv6 visitors may deliver visits to this site.
  • browsing object
    Browsing options.
    • max_sub_windows integer (0–1)
      How many pop-up windows the visited site may open during a visit.
  • location_targeting object
    Country/continent targeting.
    • mode string (include, exclude)
      Whether the locations list is an allow-list (include) or a block-list (exclude).
    • locations object[]
      The countries/continents to include or exclude.
  • blocked_domains object
    Domains blocked during visits.
    • rate integer (0–100)
      Percentage of visits to which domain blocking applies.
    • domains string[]
      Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
  • actions object
    Auto-actions performed during visits.
    • window string (latest, first)
      Which opened browser window the actions target — the most recent (latest) or the first (first).
    • items SiteAction[]
      The actions to perform.
  • traffic_sources integer[]
    IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
  • created_at string nullable
    When it was created (UTC), or null.
• meta PageMeta
  Pagination metadata for a list response.
  • limit integer
    Page size applied (clamped).
  • offset integer
    Number of items skipped before this page.
  • total integer
    Total number of items across all pages.

{
    "data": [
        {
            "id": 2644,
            "name": "Default desktop",
            "devices": {
                "desktop": 100,
                "mobile": 0,
                "tablet": 0
            },
            "visit_duration": {
                "min_seconds": 10,
                "max_seconds": 10
            },
            "visit_distribution": "even",
            "limits": {
                "hourly": 50,
                "daily": null,
                "total": null
            },
            "schedule": {
                "active_hours_mask": null,
                "time_zone": null
            },
            "traffic_quality": {
                "low_quality_ips": true,
                "ipv6": true
            },
            "browsing": {
                "max_sub_windows": 0
            },
            "location_targeting": {
                "mode": "include",
                "locations": []
            },
            "blocked_domains": {
                "rate": 100,
                "domains": []
            },
            "actions": {
                "window": "latest",
                "items": []
            },
            "traffic_sources": [],
            "created_at": "2026-06-25T07:58:02Z"
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 1
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Template name.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 2644,
    "name": "Default desktop",
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "traffic_sources": [],
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Template name.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 2644,
    "name": "Default desktop",
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "traffic_sources": [],
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Template name.
• devices object
  Device targeting split, as percentages summing to 100.
  • desktop integer (0–100)
    Percentage of visits sent to desktop devices.
  • mobile integer (0–100)
    Percentage of visits sent to mobile devices.
  • tablet integer (0–100)
    Percentage of visits sent to tablet devices.
• visit_duration object
  Visit duration range, in seconds.
  • min_seconds integer (10–600)
    Shortest visit duration, in seconds.
  • max_seconds integer (10–600)
    Longest visit duration, in seconds.
• visit_distribution string (even, asap)
  How visits are paced — "even" spreads them across the day, "asap" delivers as fast as possible.
• limits object
  Visit caps; null means no limit.
  • hourly integer (1–500)
    Max visits per hour — always at least 1 (an hourly cap is mandatory).
  • daily integer nullable (1–10000)
    Max visits per day; null means no limit.
  • total integer nullable (1–500000)
    Max visits in total (lifetime); null means no limit.
• schedule object
  Active-hours scheduling.
  • active_hours_mask string nullable
    A weekly on/off schedule: a 168-character string, one character per hour (24 hours × 7 days). Each is 1 (active that hour) or 0 (paused). The first character is Monday 00:00 and each next is the following hour, ending Sunday 23:00, in time_zone. null or all-1s means always on; at least one hour must be active, so an all-0s mask is rejected.
  • time_zone string nullable
    IANA time zone for the active-hours schedule (e.g. "Europe/Paris"); null uses your account timezone.
• traffic_quality object
  Traffic quality controls.
  • low_quality_ips boolean
    Whether low-quality IPs (VPN/proxy/datacenter) may deliver visits to this site.
  • ipv6 boolean
    Whether IPv6 visitors may deliver visits to this site.
• browsing object
  Browsing options.
  • max_sub_windows integer (0–1)
    How many pop-up windows the visited site may open during a visit.
• location_targeting object
  Country/continent targeting.
  • mode string (include, exclude)
    Whether the locations list is an allow-list (include) or a block-list (exclude).
  • locations object[]
    The countries/continents to include or exclude.
    • type string (country, continent)
      Whether code is a country or a continent.
    • code string
      ISO country code (alpha-2) or continent code, per type.
• blocked_domains object
  Domains blocked during visits.
  • rate integer (0–100)
    Percentage of visits to which domain blocking applies.
  • domains string[]
    Hostnames to block (e.g. ads.example.com; no scheme or path), one per entry. Up to 10.
• actions object
  Auto-actions performed during visits.
  • window string (latest, first)
    Which opened browser window the actions target — the most recent (latest) or the first (first).
  • items SiteAction[]
    The actions to perform.
    • type string (click, click_rss, click_sitemap, cookie, scroll, refresh)
      What the app does — click a link, click an RSS or sitemap link, set a cookie, scroll, or refresh.
    • ratio integer (0–100)
      Percentage of visits that perform this action (default 100 = every visit).
    • element object
      Present for click-type actions.
      • selection string nullable (random, first, last)
        Which element to click when several match.
      • type string nullable (any, internal_link, external_link, link, button)
        What to click: any element, a same-domain link (internal_link), an off-domain link (external_link), any link (link), or a button.
      • url_filter string nullable
        Only click links whose URL contains this text; ignored when the element type is button.
      • text_filter string nullable
        Only click elements whose visible text contains this.
    • cookie object
      Present for cookie actions.
      • name string
        Cookie name.
      • value string
        Cookie value.
      • domain string
        Domain to set the cookie on.
• traffic_sources integer[]
  IDs of assigned traffic sources (resolve via GET /v1/traffic-sources).
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 2644,
    "name": "Default desktop",
    "devices": {
        "desktop": 100,
        "mobile": 0,
        "tablet": 0
    },
    "visit_duration": {
        "min_seconds": 10,
        "max_seconds": 10
    },
    "visit_distribution": "even",
    "limits": {
        "hourly": 50,
        "daily": null,
        "total": null
    },
    "schedule": {
        "active_hours_mask": null,
        "time_zone": null
    },
    "traffic_quality": {
        "low_quality_ips": true,
        "ipv6": true
    },
    "browsing": {
        "max_sub_windows": 0
    },
    "location_targeting": {
        "mode": "include",
        "locations": []
    },
    "blocked_domains": {
        "rate": 100,
        "domains": []
    },
    "actions": {
        "window": "latest",
        "items": []
    },
    "traffic_sources": [],
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data TrafficSource[]
  • id integer
    Unique identifier.
  • name string nullable
    Name of the traffic source; a default is shown when unset.
  • referer string
    The referer reported to the target site. Only the scheme is removed, so https://www.google.com/ is stored as www.google.com/.
  • premium boolean
    Whether this source is gated to Premium. Premium sources (your custom ones, plus some shared ones) are unassigned from your sites if your subscription lapses.
  • custom boolean
    True for your own sources, false for shared/built-in ones. Independent of premium, since some shared sources are Premium-gated too.
  • created_at string nullable
    When it was created (UTC), or null.
• meta PageMeta
  Pagination metadata for a list response.
  • limit integer
    Page size applied (clamped).
  • offset integer
    Number of items skipped before this page.
  • total integer
    Total number of items across all pages.

{
    "data": [
        {
            "id": 166445,
            "name": "Newsletter",
            "referer": "www.google.com/",
            "premium": true,
            "custom": true,
            "created_at": "2026-06-25T07:58:02Z"
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 1
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Name of the traffic source; a default is shown when unset.
• referer string
  The referer reported to the target site. Only the scheme is removed, so https://www.google.com/ is stored as www.google.com/.
• premium boolean
  Whether this source is gated to Premium. Premium sources (your custom ones, plus some shared ones) are unassigned from your sites if your subscription lapses.
• custom boolean
  True for your own sources, false for shared/built-in ones. Independent of premium, since some shared sources are Premium-gated too.
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 166445,
    "name": "Newsletter",
    "referer": "www.google.com/",
    "premium": true,
    "custom": true,
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Name of the traffic source; a default is shown when unset.
• referer string
  The referer reported to the target site. Only the scheme is removed, so https://www.google.com/ is stored as www.google.com/.
• premium boolean
  Whether this source is gated to Premium. Premium sources (your custom ones, plus some shared ones) are unassigned from your sites if your subscription lapses.
• custom boolean
  True for your own sources, false for shared/built-in ones. Independent of premium, since some shared sources are Premium-gated too.
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 166445,
    "name": "Newsletter",
    "referer": "www.google.com/",
    "premium": true,
    "custom": true,
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string nullable
  Name of the traffic source; a default is shown when unset.
• referer string
  The referer reported to the target site. Only the scheme is removed, so https://www.google.com/ is stored as www.google.com/.
• premium boolean
  Whether this source is gated to Premium. Premium sources (your custom ones, plus some shared ones) are unassigned from your sites if your subscription lapses.
• custom boolean
  True for your own sources, false for shared/built-in ones. Independent of premium, since some shared sources are Premium-gated too.
• created_at string nullable
  When it was created (UTC), or null.

{
    "id": 166445,
    "name": "Newsletter",
    "referer": "www.google.com/",
    "premium": true,
    "custom": true,
    "created_at": "2026-06-25T07:58:02Z"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data Label[]
  • id integer
    Unique identifier.
  • name string
    Label name.
  • color string (#6610f2, #6f42c1, #d63384, #dc3545, #fd7e14, #ffc107, #198754, #20c997, #0dcaf0, #6c757d, #343a40)
    Label color.
  • description string nullable
    Optional notes.
• meta PageMeta
  Pagination metadata for a list response.
  • limit integer
    Page size applied (clamped).
  • offset integer
    Number of items skipped before this page.
  • total integer
    Total number of items across all pages.

{
    "data": [
        {
            "id": 1744,
            "name": "Campaign A",
            "color": "#0dcaf0",
            "description": "Q1 landing pages"
        }
    ],
    "meta": {
        "limit": 50,
        "offset": 0,
        "total": 1
    }
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string
  Label name.
• color string (#6610f2, #6f42c1, #d63384, #dc3545, #fd7e14, #ffc107, #198754, #20c997, #0dcaf0, #6c757d, #343a40)
  Label color.
• description string nullable
  Optional notes.

{
    "id": 1744,
    "name": "Campaign A",
    "color": "#0dcaf0",
    "description": "Q1 landing pages"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string
  Label name.
• color string (#6610f2, #6f42c1, #d63384, #dc3545, #fd7e14, #ffc107, #198754, #20c997, #0dcaf0, #6c757d, #343a40)
  Label color.
• description string nullable
  Optional notes.

{
    "id": 1744,
    "name": "Campaign A",
    "color": "#0dcaf0",
    "description": "Q1 landing pages"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• id integer
  Unique identifier.
• name string
  Label name.
• color string (#6610f2, #6f42c1, #d63384, #dc3545, #fd7e14, #ffc107, #198754, #20c997, #0dcaf0, #6c757d, #343a40)
  Label color.
• description string nullable
  Optional notes.

{
    "id": 1744,
    "name": "Campaign A",
    "color": "#0dcaf0",
    "description": "Q1 landing pages"
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data Screenshot[]
  • uid string
    Unique id for this visit's screenshot set.
  • device string (desktop, mobile, tablet)
    Device category the visit ran on.
  • orientation string (landscape, portrait)
    Screen orientation.
  • country_code string nullable
    ISO country code of the visitor, or null.
  • country_name string nullable
    Localized country name, or null.
  • visit_duration_seconds integer
    How long the visit lasted, in seconds.
  • images ScreenshotImage[]
    The captured images, one per browser window.
    • url string
      URL to fetch the screenshot image.
    • preview_url string nullable
      URL to fetch the blurred preview, or null.
    • window integer
      Browser window index the image was captured from.
    • width integer
      Image width in pixels.
    • height integer
      Image height in pixels.
    • delay_seconds integer
      Seconds into the visit when the image was captured.
    • captured_at string
      When the image was captured.

{
    "data": [
        {
            "uid": "2659c544-81ab-4841-912b-4005336a2a2e",
            "device": "desktop",
            "orientation": "landscape",
            "country_code": "US",
            "country_name": "United States",
            "visit_duration_seconds": 45,
            "images": [
                {
                    "url": "https://api.feelingsurf.fr/v1/screenshots/c99c25613c8b956ba2b3b0f1f764ce83",
                    "preview_url": "https://api.feelingsurf.fr/v1/screenshots/c99c25613c8b956ba2b3b0f1f764ce83/preview",
                    "window": 0,
                    "width": 1280,
                    "height": 720,
                    "delay_seconds": 5,
                    "captured_at": "2026-06-25T09:00:00Z"
                }
            ]
        }
    ]
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• data TrafficAvailability[]
  • code string
    ISO 3166-1 alpha-2 country code.
  • name string
    Localized country name.
  • continent string
    ISO continent code (EU, AS, NA, AF, SA, OC, AN).
  • availability string (none, low, medium, high)
    Relative volume of surfer traffic available in this country.

{
    "data": [
        {
            "code": "AD",
            "name": "Andorra",
            "continent": "EU",
            "availability": "low"
        }
    ]
}

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).

• error object
  Error details.
  • code string
    Stable, locale-independent error code.
  • message string
    Human-readable description (English).