# Pinterest Content Scheduler & Analytics Scraper (BYOC) (`viralanalyzer/pinterest-content-scheduler`) Actor Schedule pins, fetch boards, and retrieve pin metrics via official Pinterest API v5 (OAuth2 BYOC). - **URL**: https://apify.com/viralanalyzer/pinterest-content-scheduler.md - **Developed by:** [viralanalyzer](https://apify.com/viralanalyzer) (community) - **Categories:** Social media, Marketing - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Pinterest Pin Scheduler & Analytics Create and schedule Pinterest pins or read board data via official Pinterest API v5. ### Pricing - USD 0.05 per pin created - USD 0.01 per item fetched (boards/pins list) ### Input - mode (required): list-boards | create-pin | get-user-pins - accessToken (required): Pinterest OAuth2 token (developers.pinterest.com) - boardId: required for create-pin and get-user-pins - pinTitle, imageUrl, pinDescription, linkUrl: required for create-pin - maxItems: 1-250 (default 25) ### Pinterest API Setup 1. Create app at developers.pinterest.com 2. Request boards:read + pins:write scopes 3. Get access token via OAuth2 flow # Actor input Schema ## `mode` (type: `string`): Operation mode: create-pin (post a new pin), list-boards (get user boards), or get-user-pins (list pins on a board). ## `accessToken` (type: `string`): Pinterest OAuth2 access token. Get it at developers.pinterest.com — requires an approved app with boards:read and/or pins:write scopes. ## `boardId` (type: `string`): Target board ID. Required for create-pin and get-user-pins modes. Example: 123456789012345678. ## `pinTitle` (type: `string`): Title for the new pin. Required for create-pin mode. Max 100 characters. ## `pinDescription` (type: `string`): Description for the new pin. Optional but recommended. Max 500 characters. ## `imageUrl` (type: `string`): Direct URL to the image for the pin. Must be publicly accessible. Required for create-pin mode. ## `linkUrl` (type: `string`): Destination URL when users click the pin. Optional. ## `maxItems` (type: `integer`): Maximum number of boards or pins to return for list modes. Range 1-250. ## Actor input object example ```json { "mode": "list-boards", "pinTitle": "Check this out!", "imageUrl": "https://example.com/image.jpg", "maxItems": 25 } ```` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "list-boards", "accessToken": "", "boardId": "", "pinTitle": "Check this out!", "pinDescription": "", "imageUrl": "https://example.com/image.jpg", "linkUrl": "", "maxItems": 25 }; // Run the Actor and wait for it to finish const run = await client.actor("viralanalyzer/pinterest-content-scheduler").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "list-boards", "accessToken": "", "boardId": "", "pinTitle": "Check this out!", "pinDescription": "", "imageUrl": "https://example.com/image.jpg", "linkUrl": "", "maxItems": 25, } # Run the Actor and wait for it to finish run = client.actor("viralanalyzer/pinterest-content-scheduler").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "list-boards", "accessToken": "", "boardId": "", "pinTitle": "Check this out!", "pinDescription": "", "imageUrl": "https://example.com/image.jpg", "linkUrl": "", "maxItems": 25 }' | apify call viralanalyzer/pinterest-content-scheduler --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=viralanalyzer/pinterest-content-scheduler", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Pinterest Content Scheduler & Analytics Scraper (BYOC)", "description": "Schedule pins, fetch boards, and retrieve pin metrics via official Pinterest API v5 (OAuth2 BYOC).", "version": "1.0", "x-build-id": "pknBh0fOSjuxSxIvE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~pinterest-content-scheduler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-pinterest-content-scheduler", "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/viralanalyzer~pinterest-content-scheduler/runs": { "post": { "operationId": "runs-sync-viralanalyzer-pinterest-content-scheduler", "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/viralanalyzer~pinterest-content-scheduler/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-pinterest-content-scheduler", "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": [ "mode", "accessToken" ], "properties": { "mode": { "title": "Mode", "enum": [ "list-boards", "create-pin", "get-user-pins" ], "type": "string", "description": "Operation mode: create-pin (post a new pin), list-boards (get user boards), or get-user-pins (list pins on a board).", "default": "list-boards" }, "accessToken": { "title": "Pinterest Access Token", "type": "string", "description": "Pinterest OAuth2 access token. Get it at developers.pinterest.com — requires an approved app with boards:read and/or pins:write scopes." }, "boardId": { "title": "Board ID", "type": "string", "description": "Target board ID. Required for create-pin and get-user-pins modes. Example: 123456789012345678." }, "pinTitle": { "title": "Pin Title", "type": "string", "description": "Title for the new pin. Required for create-pin mode. Max 100 characters." }, "pinDescription": { "title": "Pin Description", "type": "string", "description": "Description for the new pin. Optional but recommended. Max 500 characters." }, "imageUrl": { "title": "Image URL", "type": "string", "description": "Direct URL to the image for the pin. Must be publicly accessible. Required for create-pin mode." }, "linkUrl": { "title": "Link URL", "type": "string", "description": "Destination URL when users click the pin. Optional." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of boards or pins to return for list modes. Range 1-250.", "default": 25 } } }, "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 } } } } } } } } } } ```