Documentation

Everything you need to integrate AuditYourStore into your workflow — REST API, MCP server for AI assistants, audit methodology, and more.

Getting Started

AuditYourStore is an AI-powered eCommerce CRO audit tool that analyzes your online store across 277+ checkpoints in 7 categories. Three ways to use it:

Quick start — Free audit

Go to ai.audityourstore.com

Enter your store URL and email address

Verify your email — click the link we send

Your audit runs automatically — results in 60-90 seconds

Quick start — API

Generate an API key in Dashboard → API Keys

Purchase audit credits at Pricing

POST /api/v1/audit with your store URL

GET /api/v1/audit/:jobId — poll until status is completed

GET /api/v1/report/:slug — retrieve the full report

REST API Reference

Base URL: https://ai.audityourstore.com/api/v1

Authentication

Pass your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Generate keys in Dashboard → API Keys. Each audit costs 1 credit.

POST/api/v1/audit

Submit a new audit. Costs 1 credit. Returns a job ID for polling.

Request body

{
  "url": "https://mystore.com",
  "industry": "fashion",     // optional
  "platform": "shopify"      // optional
}

Response (202)

{
  "jobId": "abc123",
  "status": "queued",
  "message": "Audit queued. Poll GET /api/v1/audit/abc123 for progress."
}

GET/api/v1/audit/:jobId

Check audit status and progress. Poll until status is completed.

Response

{
  "jobId": "abc123",
  "status": "analyzing",   // queued | crawling | analyzing | scoring | completed | failed
  "progress": 65,
  "progressMessage": "Running CRO checks...",
  "reportSlug": null       // populated when completed
}

GET/api/v1/report/:slug

Retrieve the full audit report with all findings, scores, and recommendations.

Response (key fields)

{
  "url": "https://mystore.com",
  "overallScore": 62,
  "overallGrade": "C",
  "categoryScores": {
    "product_pages": { "score": 75, "grade": "B" },
    "checkout": { "score": 45, "grade": "D" },
    ...
  },
  "ruleResults": [ ... ],    // 277+ individual check results
  "aiFindings": [ ... ],     // AI-generated insights
  "quickWins": [ ... ],      // Top fixes by revenue impact
  "screenshots": { ... }     // Page screenshots (base64)
}

GET/api/v1/credits

Check your remaining audit credits.

Response

{
  "credits": 4,
  "email": "[email protected]"
}

Rate Limits

10/hrAudits per API key

100/minStatus poll requests

HeadersX-RateLimit-Remaining, X-RateLimit-Reset

MCP Server for AI Assistants

Connect AuditYourStore to Claude Code, Cursor, Windsurf, or any MCP-compatible AI assistant.

What is MCP?

MCP (Model Context Protocol) is an open standard that lets AI assistants use external tools. Ask Claude to “audit mystore.com” and get full CRO results inside your conversation — no browser needed.

Setup

Generate an API key

Go to Dashboard → API Keys and create a new key.

Add MCP config

Claude Code: Add to ~/.claude/claude_desktop_config.json
Cursor: Add to .cursor/mcp.json in your project

{
  "mcpServers": {
    "audityourstore": {
      "command": "npx",
      "args": ["-y", "audityourstore-mcp"],
      "env": {
        "AUDITYOURSTORE_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Start using it

Restart your AI assistant and try one of the example prompts below.

Available Tools

audit_store1 credit

Run a full CRO audit on any eCommerce URL

get_audit_statusFree

Check progress of a running audit

get_reportFree

Retrieve full report with all findings and AI insights

check_creditsFree

See remaining audit credits

Example Prompts

“Audit https://mystore.com and tell me the top 5 things killing conversions”

“Run a CRO audit on competitor.com and compare their checkout flow to ours”

“Check how many audit credits I have left”

“Get the full report for my last audit and export findings as a CSV”

Audit Methodology

AuditYourStore evaluates your store across 277+ checkpoints in 7 categories. Each check is backed by UX research from the Baymard Institute, Nielsen Norman Group, and Google's Web Vitals guidelines.

Product Pages

50+

Image quality, descriptions, pricing clarity, reviews, CTAs, cross-sell placement, trust badges, mobile layout.

Sources: Baymard Institute product page UX guidelines

Checkout Flow

40+

Form fields, guest checkout, payment methods, address autocomplete, shipping calculator, progress indicator, error handling.

Sources: Baymard Institute checkout usability (70.19% cart abandonment)

Trust & Credibility

30+

SSL, security badges, return policy, contact info, review authenticity, social proof, guarantees, privacy policy.

Sources: Nielsen Norman Group trust signal research

Mobile Experience

35+

Tap targets (48x48px min), responsive design, viewport config, touch navigation, mobile menu, swipe gestures.

Sources: Google Mobile Usability, WCAG 2.1 AA

Page Performance

25+

Core Web Vitals (LCP < 2.5s, INP < 200ms, CLS < 0.1), image optimization, render-blocking, server response.

Sources: Google Core Web Vitals, HTTP Archive benchmarks

Navigation & Search

30+

Menu structure, breadcrumbs, category filters, site search, internal linking, 404 handling, URL structure.

Sources: Baymard Institute navigation UX, NNGroup information architecture

Email & Retention

20+

Email deliverability (SPF, DKIM, DMARC), blacklist checks, welcome emails, abandoned cart recovery, unsubscribe compliance.

Sources: RFC 7208 (SPF), RFC 7489 (DMARC), CAN-SPAM Act

How Scoring Works

Each checkpoint returns pass, fail, or uncertain with a weighted score. The overall score (0-100) maps to a letter grade:

90-100

75-89

60-74

40-59

0-39

Revenue impact estimates use your store's traffic data (when available via CSV import) combined with industry conversion benchmarks to project monthly revenue loss per finding.

AI Vision Analysis

Beyond automated rule checks, AuditYourStore uses Claude's computer vision to analyze screenshots of your store pages. The AI identifies visual UX issues that rule-based checks can't catch: cluttered layouts, poor visual hierarchy, confusing navigation patterns, and missing design best practices.

Integrations

Microsoft Clarity

Connect Clarity to fold real visitor behavior — rage-clicks, dead-clicks, quick-backs, low scroll — into your audit as scored findings.

Dashboard → Integrations

CSV Data Import

Upload revenue and traffic data from any analytics platform (Google Analytics, Hotjar, etc.) via CSV with columns for date, sessions, conversions, and revenue.

Dashboard → Data Import

Figma Export

Export findings directly to Figma. Each finding is placed as an annotation on the page screenshot for easy designer handoff.

Google Sheets

Export the full report to a structured spreadsheet with all findings, severity ratings, revenue impact estimates, and fix instructions.

Webhooks

Receive real-time POST callbacks when audits complete. Configure webhook URLs in your project settings.

eCommerce CRO Glossary

Key terms used in audit reports and CRO optimization.

Conversion Rate (CR)

Metric

Percentage of visitors who complete a desired action. Average eCommerce CR is 2.5-3.5%.

Cart Abandonment Rate

Metric

Percentage who add to cart but don't buy. Average is 70.19% (Baymard Institute).

Average Order Value (AOV)

Metric

Average revenue per transaction. Increased through cross-sells, upsells, bundles.

Core Web Vitals (CWV)

Technical

Google's page experience metrics: LCP (<2.5s), INP (<200ms), CLS (<0.1).

Above the Fold

Content visible without scrolling. 80% of user attention is spent here.

Social Proof

Reviews, ratings, testimonials, 'X people bought this', and user-generated content.

Trust Signals

SSL, payment badges, return policies, contact info, reviews, guarantees.

Tap Target

Technical

Interactive mobile element. Google recommends minimum 48x48px with 8px spacing.

SPF

DNS record specifying which servers can send email for your domain.

DKIM

Email authentication that adds a digital signature verified via DNS.

DMARC

Policy for emails failing SPF/DKIM: none, quarantine, or reject.

Revenue Impact Estimate

Metric

Projected monthly revenue change from fixing a specific issue.

Quick Wins

Strategy

High-impact, low-effort fixes prioritized by estimated revenue impact.

MCP

Technical

Model Context Protocol — open standard connecting AI assistants to external tools.

Troubleshooting

Audit blocked by Cloudflare or firewall

If your store uses Cloudflare, Sucuri, or another WAF/firewall that blocks automated requests, the audit may fail with a “Site Unreachable” error. To fix this, whitelist our server IP in your firewall settings.

Server IP Address

65.21.84.158

User Agents

AuditYourStore Bot/1.0

AuditYourStore/1.0

The crawler also uses standard Chrome user agents for screenshot capture.

How to whitelist in Cloudflare:

Log into your Cloudflare dashboard and select your domain

Go to Security → WAF → Tools → IP Access Rules

Add 65.21.84.158, set action to "Allow", scope "This website"

Important: if Bot Fight Mode is enabled (Security → Bots), turn it OFF — Bot Fight Mode ignores allow rules and will keep challenging our crawler even after step 3

Re-run your audit

Still blocked? Add a WAF Skip rule (works on every Cloudflare plan)

A custom rule with the “Skip” action bypasses managed challenges, rate limiting, and browser checks for our IP only — everything else on your site stays protected:

Go to Security → WAF → Custom rules → Create rule

Name it "AuditYourStore". Field: IP Source Address, Operator: equals, Value: 65.21.84.158

Choose action "Skip" and tick: All remaining custom rules, Rate limiting rules, plus (under additional components) Browser Integrity Check and Security Level

Deploy the rule, then re-run your audit

Our crawler always attempts your store from the IP above first, so once it is allowed, audits pass without any human-verification prompt. Audits are read-only and load a few dozen pages at most.

For Shopify stores: Go to Settings → Online Store → Preferences and check if Bot Protection is blocking our requests. You may need to contact Shopify support to whitelist our IP.

Shopify Crawler Authorization (recommended for Shopify stores)

Shopify lets store owners grant trusted bots access with a signed authorization. This is the most reliable fix when Shopify keeps blocking audits:

In your Shopify admin, generate a crawler access signature for AuditYourStore (Signature, Signature-Input, and Signature-Agent values).

Open your AuditYourStore dashboard → Settings → Shopify Crawler Authorization.

Enter your store domain and paste the three signature values, then save.

Re-run your audit — we send these as HTTP headers so Shopify lets our crawler through.

Audit shows "Site Unreachable" but my site works fine

Your firewall or hosting provider may be blocking our crawler. Whitelist IP 65.21.84.158 in your firewall settings (see the Cloudflare steps above — including turning off Bot Fight Mode, which ignores allow rules). This commonly happens with Cloudflare, Sucuri, Wordfence, and Shopify bot protection.

Audit takes longer than 2 minutes

Large stores with many pages may take 3-5 minutes. If the audit seems stuck, check if your site has aggressive rate limiting that is throttling our crawler. Whitelisting our IP usually resolves this.

Screenshots look wrong or show a cookie/age gate

Our crawler renders pages like a real browser but cannot accept cookie banners, age verification, or GDPR popups. If your site requires user interaction before showing content, the screenshots will capture the overlay instead of your actual pages.

PayPal payment completed but credits not showing

If your browser closed during PayPal checkout, the credit grant may have failed. Contact us at [email protected] with your PayPal receipt and we'll add your credits immediately.

Still having issues? Email us at [email protected] and we'll help you out.

Ready to audit your store?

Start with a free 25-point audit — no credit card required.

Run Free Audit View Pricing

Documentation

Getting Started

Web App

REST API

MCP Server

Quick start — Free audit

Quick start — API

REST API Reference

Authentication

Request body

Response (202)

Response

Response (key fields)

Response

Rate Limits

MCP Server for AI Assistants

What is MCP?

Setup

Available Tools

Example Prompts

Audit Methodology

Product Pages

Checkout Flow

Trust & Credibility

Mobile Experience

Page Performance

Navigation & Search

Email & Retention

How Scoring Works

AI Vision Analysis

Integrations

Microsoft Clarity

CSV Data Import

Figma Export

Google Sheets

Webhooks

eCommerce CRO Glossary

Troubleshooting

Audit blocked by Cloudflare or firewall

How to whitelist in Cloudflare:

Still blocked? Add a WAF Skip rule (works on every Cloudflare plan)

Shopify Crawler Authorization (recommended for Shopify stores)

Audit shows "Site Unreachable" but my site works fine

Audit takes longer than 2 minutes

Screenshots look wrong or show a cookie/age gate

PayPal payment completed but credits not showing

Ready to audit your store?