# E-commerce Store Audit (`gentle_cloud/ecommerce-audit`) Actor

Audit e-commerce stores in one run: detect platform, Shopify theme and apps, crawl technical structure, run Lighthouse, validate public contact emails, and return an actionable risk score.

- **URL**: https://apify.com/gentle_cloud/ecommerce-audit.md
- **Developed by:** [Monkey Coder](https://apify.com/gentle_cloud) (community)
- **Categories:** E-commerce, SEO tools, Marketing
- **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.05 / actor start

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## E-commerce Store Audit

Run one audit for each store URL and receive a compact, actionable report. The Actor combines four existing capabilities:

1. **Platform and stack** — detects Shopify, WooCommerce, Magento, BigCommerce, Shopify theme, public apps, currency, language, and sample product availability.
2. **Technical crawl** — crawls bounded internal links, reports status codes, redirects, broken pages, word counts, internal/external links, and optionally produces XML sitemap content.
3. **Lighthouse quality** — runs mobile or desktop Lighthouse and returns Performance, Accessibility, Best Practices, SEO, Core Web Vitals, and failed audits.
4. **Lead quality** — finds public contact emails and validates syntax, MX, disposable domains, role addresses, and free providers.

Each store produces one dataset item with nested `lighthouse`, `sitemap`, `emails_found`, `score_components`, and `issues` fields. `audit_score` is a transparent 0–100 weighted score: platform 15%, performance 25%, SEO 25%, accessibility 15%, crawl health 10%, and contact quality 10%.

### Example input

```json
{
  "start_urls": [{"url": "https://www.gymshark.com"}],
  "max_depth": 1,
  "max_pages": 15,
  "run_lighthouse": true,
  "strategy": "mobile",
  "check_email_dns": true
}
```

Use `run_lighthouse: false` for a faster prospecting pass, then run selected stores again with Lighthouse for a sales-ready audit. The Actor emits structured errors for invalid or unavailable stores and never duplicates placeholder records.

# Actor input Schema

## `start_urls` (type: `array`):

E-commerce store homepages to audit. Shopify, WooCommerce, Magento, BigCommerce, and unknown platforms are supported.

## `max_depth` (type: `integer`):

Internal link depth for the technical crawl.

## `max_pages` (type: `integer`):

Maximum pages crawled per store.

## `run_lighthouse` (type: `boolean`):

Run mobile or desktop Lighthouse performance, accessibility, SEO, and best-practice audits.

## `strategy` (type: `string`):

Lighthouse device strategy.

## `lighthouse_categories` (type: `string`):

Comma-separated categories: performance, accessibility, best-practices, seo.

## `lighthouse_timeout` (type: `integer`):

Maximum time for one Lighthouse audit.

## `check_email_dns` (type: `boolean`):

Check syntax and MX records for public contact emails found on the homepage.

## `include_sitemap_xml` (type: `boolean`):

Include generated XML in the report. Disabled by default to keep output compact.

## `request_timeout` (type: `integer`):

Timeout for homepage and enrichment requests.

## Actor input object example

```json
{
  "start_urls": [
    {
      "url": "https://www.gymshark.com"
    }
  ],
  "max_depth": 1,
  "max_pages": 15,
  "run_lighthouse": true,
  "strategy": "mobile",
  "lighthouse_categories": "performance,accessibility,best-practices,seo",
  "lighthouse_timeout": 120,
  "check_email_dns": true,
  "include_sitemap_xml": false,
  "request_timeout": 30
}
```

# Actor output Schema

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

Dataset items containing platform, crawl, Lighthouse, email, score, and issue details.

# 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 = {
    "start_urls": [
        {
            "url": "https://www.gymshark.com"
        }
    ],
    "max_depth": 1,
    "max_pages": 15,
    "strategy": "mobile",
    "lighthouse_categories": "performance,accessibility,best-practices,seo",
    "lighthouse_timeout": 120,
    "request_timeout": 30
};

// Run the Actor and wait for it to finish
const run = await client.actor("gentle_cloud/ecommerce-audit").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 = {
    "start_urls": [{ "url": "https://www.gymshark.com" }],
    "max_depth": 1,
    "max_pages": 15,
    "strategy": "mobile",
    "lighthouse_categories": "performance,accessibility,best-practices,seo",
    "lighthouse_timeout": 120,
    "request_timeout": 30,
}

# Run the Actor and wait for it to finish
run = client.actor("gentle_cloud/ecommerce-audit").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 '{
  "start_urls": [
    {
      "url": "https://www.gymshark.com"
    }
  ],
  "max_depth": 1,
  "max_pages": 15,
  "strategy": "mobile",
  "lighthouse_categories": "performance,accessibility,best-practices,seo",
  "lighthouse_timeout": 120,
  "request_timeout": 30
}' |
apify call gentle_cloud/ecommerce-audit --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,gentle_cloud/ecommerce-audit"
        }
    }
}
```

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/0JlcsIuXhFoF99X2U/builds/CGlVaT99nKAYOT6Dt/openapi.json
