{ "openapi": "3.0.1", "info": { "title": "Citation God Mode - Ultimate NAP Consistency Checker", "description": "Citation God Mode combining 4 powerful engines into 1 comprehensive tool:\nMoz Integration - Quick scan Moz's listing tool (50+ directories)\nDirect Scraping - Deep scrape of 60+ directories\nCross-Validation - Determines \"canonical\" NAP by weighing data\nAI Analysis - recommendations & fix suggestions", "version": "1.0", "x-build-id": "okWLpPPgH7bv5wjfp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~citation-god-mode/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-citation-god-mode", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~citation-god-mode/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-citation-god-mode", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~citation-god-mode/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-citation-god-mode", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "businessName": { "title": "Business Name", "type": "string", "description": "The exact business name to check across all directories" }, "streetAddress": { "title": "Street Address", "type": "string", "description": "Street address (e.g., '123 Main St Suite 100')" }, "city": { "title": "City", "type": "string", "description": "City name" }, "state": { "title": "State", "maxLength": 2, "type": "string", "description": "State abbreviation (e.g., 'FL', 'CA')" }, "zipCode": { "title": "ZIP Code", "type": "string", "description": "5-digit ZIP code" }, "phone": { "title": "Phone Number", "type": "string", "description": "Business phone number in any format" }, "website": { "title": "Website URL", "type": "string", "description": "Business website (optional)" }, "industry": { "title": "Business Industry", "type": "string", "description": "Business industry/category for filtering relevant platforms (e.g., 'restaurant', 'plumber', 'lawyer', 'real estate'). Platforms not relevant to your industry will be marked as N/A and won't affect your score." }, "googlePlaceId": { "title": "Google Place ID", "type": "string", "description": "Google Maps Place ID for the business. When provided, GBP is automatically marked as 'correct' since it's the source of truth for NAP data." }, "scanMode": { "title": "Scan Mode", "enum": [ "quick", "standard", "deep", "god-mode" ], "type": "string", "description": "Choose scan depth: quick (Moz only ~2min), standard (top 20 directories ~5min), deep (all 60+ directories ~15min), god-mode (everything + AI ~20min)", "default": "standard" }, "enableMozScan": { "title": "Enable Moz Scan", "type": "boolean", "description": "Run Moz Local Listing checker (free tier, checks 50+ directories quickly)", "default": true }, "enableDirectScrape": { "title": "Enable Direct Scraping", "type": "boolean", "description": "Directly scrape directory platforms for detailed NAP data", "default": true }, "useDedicatedScrapers": { "title": "Use Dedicated Scrapers", "type": "boolean", "description": "Use our dedicated Apify scrapers for Yelp, Manta, Houzz, DoorDash, and Grubhub (more reliable but uses additional compute)", "default": true }, "enableCrossValidation": { "title": "Enable Cross-Validation", "type": "boolean", "description": "Cross-reference data from multiple sources to determine canonical NAP", "default": true }, "enableAiAnalysis": { "title": "Enable AI Analysis", "type": "boolean", "description": "Use Claude AI to generate recommendations and fix suggestions", "default": true }, "anthropicApiKey": { "title": "Anthropic API Key", "type": "string", "description": "Your Anthropic API key for Claude AI analysis (required if AI analysis enabled)" }, "platforms": { "title": "Specific Platforms", "type": "array", "description": "Only check these specific platforms (leave empty for all based on scan mode)", "items": { "type": "string" } }, "providedUrls": { "title": "Known Listing URLs", "type": "object", "description": "Pre-known URLs for specific platforms (e.g., {\"yelp\": \"https://yelp.com/biz/...\"})" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST results to when complete" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data to test the actor without real scraping", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }