{
"openapi": "3.0.1",
"info": {
"title": "SEO Agency Report - White-Label SEO & AI Visibility Audit",
"description": "One domain in, one client-ready SEO report out: rankings, top 100 keywords, quick wins, competitors, domain authority, backlinks, live SERPs, PageSpeed and ChatGPT / Google AI Mode visibility. White-label HTML + PDF and JSON. $2.49 per report.",
"version": "1.0",
"x-build-id": "Zrg4pxTmJZXlo26Q9"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wrenfield-data~seo-agency-report/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wrenfield-data-seo-agency-report",
"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/wrenfield-data~seo-agency-report/runs": {
"post": {
"operationId": "runs-sync-wrenfield-data-seo-agency-report",
"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/wrenfield-data~seo-agency-report/run-sync": {
"post": {
"operationId": "run-sync-wrenfield-data-seo-agency-report",
"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",
"required": [
"domain"
],
"properties": {
"domain": {
"title": "Website (domain)",
"type": "string",
"description": "The site to report on, e.g. example.com. A full URL also works; the report covers the whole domain including subdomains."
},
"competitors": {
"title": "Competitors (optional)",
"type": "array",
"description": "Up to 5 competitor domains to benchmark. Leave empty to find the top 5 organic competitors automatically.",
"items": {
"type": "string"
}
},
"keywords": {
"title": "Target keywords (optional)",
"type": "array",
"description": "Up to 20 keywords your client wants to rank for. Each gets search volume, keyword difficulty, intent and (for the first ones) a live Google check of your position, competitors and AI Overview citation. Leave empty to use the site's own top keywords.",
"items": {
"type": "string"
}
},
"location": {
"title": "Country",
"type": "string",
"description": "Search market: a country name (\"United Kingdom\"), 2-letter code (\"GB\") or location code (2826).",
"default": "United States"
},
"language": {
"title": "Language (optional)",
"type": "string",
"description": "Language name or code, e.g. \"English\" or \"de\". Defaults to the country's main language."
},
"brandName": {
"title": "Brand name (optional)",
"type": "string",
"description": "How the brand is written in AI answers, e.g. \"Acme Plumbing\". Separate variants with commas. Defaults to the domain name."
},
"aiPrompts": {
"title": "AI prompts (optional)",
"type": "array",
"description": "Up to 5 questions to ask ChatGPT and Google AI Mode, e.g. \"best emergency plumber in Austin\". Leave empty to generate buyer questions from the site's keywords.",
"items": {
"type": "string"
}
},
"aiPromptCount": {
"title": "Number of AI prompts",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "How many prompts to check on each engine (0 to skip). Included in the report price.",
"default": 5
},
"includeAiVisibility": {
"title": "Include AI search visibility",
"type": "boolean",
"description": "Check whether ChatGPT and Google AI Mode mention or cite the brand.",
"default": true
},
"agencyName": {
"title": "Agency name",
"type": "string",
"description": "Shown in the report header and footer (white-label)."
},
"agencyLogoUrl": {
"title": "Agency logo URL",
"type": "string",
"description": "Public PNG or JPG URL of your logo, shown top-left."
},
"accentColor": {
"title": "Accent colour",
"type": "string",
"description": "Hex colour for headings and charts, e.g. #0F766E."
},
"clientName": {
"title": "Client name",
"type": "string",
"description": "Shown as \"prepared for …\" under the title."
},
"reportTitle": {
"title": "Report title",
"type": "string",
"description": "Defaults to \"SEO & AI Search Visibility Report\"."
},
"includePdf": {
"title": "Create a PDF",
"type": "boolean",
"description": "Also save the report as a PDF (the HTML report is always saved).",
"default": true
},
"includePageSpeed": {
"title": "Include PageSpeed",
"type": "boolean",
"description": "Test the homepage with Google PageSpeed Insights (mobile and desktop).",
"default": true
},
"pageSpeedUrl": {
"title": "Page to speed-test",
"type": "string",
"description": "Defaults to the homepage."
},
"topKeywords": {
"title": "Top keywords to include",
"minimum": 20,
"maximum": 100,
"type": "integer",
"description": "How many of the site's top ranking keywords (by traffic) to include in the data.",
"default": 100
},
"serpKeywords": {
"title": "Live SERP checks",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "How many keywords to check live on Google (target keywords first).",
"default": 5
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}