{ "openapi": "3.0.1", "info": { "title": "SEMrush Traffic Analytics - Visits, Sources & Engagement", "description": "Get comprehensive traffic analytics for any website using SEMrush data and your own API key (BYOK). Visits, unique visitors, engagement metrics, traffic sources & geographic distribution.\nTotal Visits\nUnique Visitors\nPages Per Visit\nAvg Visit Duration\nBounce Rate", "version": "1.3", "x-build-id": "bNIzyf4q4RYxE0RSR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~semrush-traffic-analytics---visits-sources-engagement/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-semrush-traffic-analytics---visits-sources-engagement", "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~semrush-traffic-analytics---visits-sources-engagement/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-semrush-traffic-analytics---visits-sources-engagement", "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~semrush-traffic-analytics---visits-sources-engagement/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-semrush-traffic-analytics---visits-sources-engagement", "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": { "semrushApiKey": { "title": "SEMrush API Key", "type": "string", "description": "Your SEMrush API key. Get it from SEMrush My Profile, then API, then Subscription Info. If left empty, the actor returns clearly labeled sample data and charges no task events." }, "domains": { "title": "Domains", "type": "array", "description": "List of domains to analyze traffic for (e.g., example.com)", "items": { "type": "string" } }, "includeHistorical": { "title": "Include Historical Data", "type": "boolean", "description": "Include monthly traffic history (last 12 months)", "default": true }, "includeTrafficSources": { "title": "Include Traffic Sources", "type": "boolean", "description": "Break down traffic by source (direct, search, social, etc.)", "default": true }, "includeGeoDistribution": { "title": "Include Geographic Distribution", "type": "boolean", "description": "Get traffic breakdown by country", "default": true }, "geoLimit": { "title": "Geo Limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Max countries to include in geo distribution", "default": 10 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional webhook URL to send results (Zapier, Make, n8n, or custom)" }, "webhookPlatform": { "title": "Webhook Platform", "enum": [ "zapier", "make", "n8n", "custom" ], "type": "string", "description": "Select your webhook platform for optimized payload formatting", "default": "custom" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return clearly labeled sample data without using the SEMrush API. Runs without an API key also fall back to labeled sample data. Sample runs charge no task events.", "default": false } } }, "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 } } } } } } } } } }