NAVNavbar
Logo
cURL php NodeJS Python cSharp

Live Social Media Pinterest Tasks

‌‌
Social Media Pinterest API will provide you with data on pins made from the specified URLs. Pins on Pinterest correspond to content saves. For each specified page URL, you will get the number of content saves to Pinterest made using the Pinterest Save Button placed on that page.

You can specify 10 pages maximum when setting a task. Your account will be charged per each URL.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
	$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
	exit();
}
$post_array = array();
// simple way to set a task
$post_array[] = array(
	"tag" => "some_string_123",
	"targets" => array(
		"https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/",
		"https://tasty.co/recipe/classic-lasagna",
		"https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/"
	)
);
try {
	// POST /v3/business_data/social_media/pinterest/live
	// the full list of possible parameters is available in documentation
	$result = $client->post('/v3/business_data/social_media/pinterest/live', $post_array);
	print_r($result);
	// do something with post result
} catch (RestClientException $e) {
	echo "\n";
	print "HTTP code: {$e->getHttpCode()}\n";
	print "Error code: {$e->getCode()}\n";
	print "Message: {$e->getMessage()}\n";
	print  $e->getTraceAsString();
	echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20210721",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.6007 sec.",
    "cost": 0.00012,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "07211752-1535-0322-0000-766ba9bb339d",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.4824 sec.",
            "cost": 0.00012,
            "result_count": 3,
            "path": [
                "v3",
                "business_data",
                "social_media",
                "pinterest",
                "live"
            ],
            "data": {
                "api": "business_data",
                "function": "pinterest",
                "targets": [
                    "https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/",
                    "https://tasty.co/recipe/classic-lasagna",
                    "https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/"
                ],
                "tag": "some_string_123"
            },
            "result": [
                {
                    "type": "social_media_pinterest_item",
                    "page_url": "https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/",
                    "pins_count": 191
                },
                {
                    "type": "social_media_pinterest_item",
                    "page_url": "https://tasty.co/recipe/classic-lasagna",
                    "pins_count": 917
                },
                {
                    "type": "social_media_pinterest_item",
                    "page_url": "https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/",
                    "pins_count": 2458
                }
            ]
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, with each POST call containing only one task.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
targets array target URLs
required field
target page should be specified with its absolute URL (including http:// or https://)
example:
https://dataforseo.com/

Note: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array

tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasksarray
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string unique task identifier in our system
in the Universally unique identifier (UUID) format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
        status_message string informational message of the task
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
                type string type of element = ‘social_media_pinterest_item’
                page_url string URL of the page the data is provided for
corresponding URL you specified in the targets array when setting a task
                pins_count integer number of pins for the related page_url
pins on Pinterest correspond to content saves;
this field shows the number of content saves made from the related page_url using the Pinterest Save Button

‌‌