{ "openapi": "3.0.1", "info": { "title": "Pinterest Keyword Research & SEO Tool", "description": "Turn one seed term into a full Pinterest keyword map. Get the related search terms Pinterest itself suggests, each with its own relevance score, plus the sites and accounts already ranking for them. Expand up to three levels, dedupe automatically, export to CSV. No Pinterest account needed.", "version": "0.0", "x-build-id": "z7Pcn1TcdMqrfawCY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apt_marble~pinterest-keyword-research/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apt_marble-pinterest-keyword-research", "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/apt_marble~pinterest-keyword-research/runs": { "post": { "operationId": "runs-sync-apt_marble-pinterest-keyword-research", "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/apt_marble~pinterest-keyword-research/run-sync": { "post": { "operationId": "run-sync-apt_marble-pinterest-keyword-research", "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": [ "seedKeywords" ], "properties": { "seedKeywords": { "title": "Seed keywords", "minItems": 1, "maxItems": 50, "type": "array", "description": "The search terms to start from. Each one is expanded into the related terms Pinterest itself suggests, with Pinterest's own relevance score.", "default": [ "coffee recipe" ], "items": { "type": "string" } }, "depth": { "title": "Expansion depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "How many rounds of expansion to run. 0 keeps only your seed terms, 1 adds the terms related to them, 2 adds the terms related to those, and so on.", "default": 2 }, "maxKeywords": { "title": "Maximum keywords", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The hard cap on how many keyword rows this run may produce. The tree stops growing as soon as the cap is reached, so this is also the cap on what the run can cost.", "default": 50 }, "includeTopPins": { "title": "Include top pins for each keyword", "type": "boolean", "description": "Attach a sample of the pins currently showing at the top of each keyword's results, with their images, links and accounts. Turn this off for a slimmer, spreadsheet-friendly export.", "default": true }, "country": { "title": "Browse from", "enum": [ "us", "gb", "ca", "au", "ie", "nz", "de", "fr", "es", "it", "nl", "be", "at", "ch", "pt", "pl", "cz", "ro", "gr", "se", "no", "dk", "fi", "ua", "tr", "il", "ae", "sa", "za", "br", "mx", "ar", "cl", "co", "in", "sg", "jp", "kr", "hk", "id", "ph", "th", "vn", "my" ], "type": "string", "description": "The country whose Pinterest results are collected. Pinterest personalises results by country, so keeping this fixed is what makes the scores in one run comparable to each other.", "default": "us" } } }, "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 } } } } } } } } } }