# Newsletter Popup Pattern Auditor (`junipr/newsletter-popup-pattern-auditor`) Actor

Detect newsletter/pop-up/modal patterns and extract trigger timing, visible fields, offer text, close controls, mobile risk, and user-experience issues

- **URL**: https://apify.com/junipr/newsletter-popup-pattern-auditor.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $27.50 / 1,000 browser page checkeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Newsletter Popup Pattern Auditor

Detect newsletter/pop-up/modal patterns and extract trigger timing, visible fields, offer text, close controls, mobile risk, and user-experience issues.

### What it does

Renders public pages after bounded waits and detects popups, offers, fields, close controls, overlay coverage, timing, and mobile UX risks.

The actor emits one row per visible popup pattern, or a no-popup diagnostic. Dataset and report output is produced only after every applicable PPE charge is accepted.

### Common uses

- Audit newsletter popup patterns
- Check mobile popup UX risk
- Extract popup offers and fields
- Find hard-to-close modals
- Compare popup behavior across pages

### Input

Supply public HTTP(S) URLs or deterministic `htmlInputs`. URL fetching rejects localhost and private-network destinations; `allowedDomains` can narrow access further.

- `startUrls`
- `sitemapUrls`
- `htmlInputs`
- `allowedDomains`
- `maxPages`
- `maxDepth`
- `includeEvidence`
- `includeRawSnapshots`
- `requestDelayMs`
- `timeoutMs`
- `userAgentMode`
- `pageUrls`
- `waitTimesMs`
- `viewportProfiles`
- `interactionMode`
- `popupSelectors`
- `maxPopupsPerPage`
- `captureScreenshots`
- `viewportWidth`
- `viewportHeight`
- `maxPopupWaitMs`
- `maxScreenshots`
- `maxBrowserPages`
- `maxChargeUsd`
- `includeReport`

The caps in `maxPages, maxPopupWaitMs, maxScreenshots, maxBrowserPages, timeoutMs` and `maxChargeUsd` are enforced. A zero charge cap is a hard zero budget.

### Output

- `sourceUrl`
- `sourceType`
- `pageTitle`
- `recordType`
- `recordName`
- `issueCode`
- `severity`
- `evidenceSnippet`
- `recommendation`
- `canonicalUrl`
- `httpStatus`
- `scannedAt`
- `pageUrl`
- `popupDetected`
- `triggerTimingMs`
- `popupType`
- `offerText`
- `fieldNames`
- `closeControlFound`
- `coversMainContent`
- `mobileViewportIssue`
- `uxIssueCode`
- `screenshotKey`

Reports:

- `newsletter-popup-pattern-auditor-summary-report.md`
- `newsletter-popup-pattern-auditor-records.csv`
- `newsletter-popup-pattern-auditor-issues.json`
- `newsletter-popup-pattern-auditor-evidence-samples.json`
- `newsletter-popup-pattern-auditor-run-metadata.json`

### Pricing

Platform-usage pass-through is off. Locked fixed-inclusive events:

| Event | Price |
| --- | ---: |
| `actor-start` | $0.08 |
| `browser-page-checked` | $0.0275 |
| `popup-pattern-detected` | $0.0195 |
| `screenshot-captured` | $0.018 |
| `report-generated` | $0.18 |

The actor charges `actor-start` before fetching/rendering, deduplicates page events, charges record/finding events only for corresponding output, and stops before further output on partial, limited, or over-budget charges. Screenshot events fire only when a real browser PNG exists.

### Safety and limitations

- Public pages only; no authentication, CAPTCHA bypass, access-control evasion, or private data.
- Browser waits, pages, records, changes, forms, popups, and screenshots are bounded.
- Blocked, empty, and missing-baseline cases produce diagnostics instead of invented success.
- Results describe source evidence at scan time and may change later.
- Store discounts, icons, publication, and scheduler state are separate live configuration gates.

### Local validation

```bash
pnpm --filter @junipr/newsletter-popup-pattern-auditor build
pnpm --filter @junipr/newsletter-popup-pattern-auditor test
pnpm --filter @junipr/newsletter-popup-pattern-auditor smoke
```

Fixtures cover success, weak/blocked evidence, comparison, no-result, and cap behavior. Tests also prove schema equality, pricing metadata, charge guards, zero budget, reports, and charge-before-output ordering.

# Actor input Schema

## `startUrls` (type: `array`):

startUrls for Newsletter Popup Pattern Auditor.

## `sitemapUrls` (type: `array`):

sitemapUrls for Newsletter Popup Pattern Auditor.

## `htmlInputs` (type: `array`):

htmlInputs for Newsletter Popup Pattern Auditor.

## `allowedDomains` (type: `array`):

allowedDomains for Newsletter Popup Pattern Auditor.

## `maxPages` (type: `integer`):

maxPages for Newsletter Popup Pattern Auditor.

## `maxDepth` (type: `integer`):

maxDepth for Newsletter Popup Pattern Auditor.

## `includeEvidence` (type: `boolean`):

includeEvidence for Newsletter Popup Pattern Auditor.

## `includeRawSnapshots` (type: `boolean`):

includeRawSnapshots for Newsletter Popup Pattern Auditor.

## `requestDelayMs` (type: `integer`):

requestDelayMs for Newsletter Popup Pattern Auditor.

## `timeoutMs` (type: `integer`):

timeoutMs for Newsletter Popup Pattern Auditor.

## `userAgentMode` (type: `string`):

userAgentMode for Newsletter Popup Pattern Auditor.

## `pageUrls` (type: `array`):

pageUrls for Newsletter Popup Pattern Auditor.

## `waitTimesMs` (type: `array`):

waitTimesMs for Newsletter Popup Pattern Auditor.

## `viewportProfiles` (type: `array`):

viewportProfiles for Newsletter Popup Pattern Auditor.

## `interactionMode` (type: `string`):

interactionMode for Newsletter Popup Pattern Auditor.

## `popupSelectors` (type: `array`):

popupSelectors for Newsletter Popup Pattern Auditor.

## `maxPopupsPerPage` (type: `integer`):

maxPopupsPerPage for Newsletter Popup Pattern Auditor.

## `captureScreenshots` (type: `boolean`):

captureScreenshots for Newsletter Popup Pattern Auditor.

## `viewportWidth` (type: `integer`):

viewportWidth for Newsletter Popup Pattern Auditor.

## `viewportHeight` (type: `integer`):

viewportHeight for Newsletter Popup Pattern Auditor.

## `maxPopupWaitMs` (type: `integer`):

maxPopupWaitMs for Newsletter Popup Pattern Auditor.

## `maxScreenshots` (type: `integer`):

maxScreenshots for Newsletter Popup Pattern Auditor.

## `maxBrowserPages` (type: `integer`):

maxBrowserPages for Newsletter Popup Pattern Auditor.

## `maxChargeUsd` (type: `number`):

maxChargeUsd for Newsletter Popup Pattern Auditor.

## `includeReport` (type: `boolean`):

includeReport for Newsletter Popup Pattern Auditor.

## Actor input object example

```json
{
  "startUrls": [],
  "sitemapUrls": [],
  "htmlInputs": [
    {
      "sourceUrl": "https://shop.example",
      "sourceType": "rendered",
      "html": "<title>Shop</title><div role='dialog' class='popup overlay'><button aria-label='Close'>x</button><h2>Save 10%</h2><input name='email'></div>"
    }
  ],
  "allowedDomains": [],
  "maxPages": 5,
  "maxDepth": 5,
  "includeEvidence": false,
  "includeRawSnapshots": false,
  "requestDelayMs": 5,
  "timeoutMs": 5,
  "userAgentMode": "",
  "pageUrls": [],
  "waitTimesMs": [],
  "viewportProfiles": [],
  "interactionMode": "",
  "popupSelectors": [],
  "maxPopupsPerPage": 10,
  "captureScreenshots": false,
  "viewportWidth": 5,
  "viewportHeight": 5,
  "maxPopupWaitMs": 5,
  "maxScreenshots": 5,
  "maxBrowserPages": 3,
  "maxChargeUsd": 50,
  "includeReport": true
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `report` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("junipr/newsletter-popup-pattern-auditor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("junipr/newsletter-popup-pattern-auditor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call junipr/newsletter-popup-pattern-auditor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,junipr/newsletter-popup-pattern-auditor"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/GfvVIAg7rCqLJ9gxn/builds/Fk44ZQcM8hTqRNKmT/openapi.json