Pinterest API: Search — Pin metrics by query

What this endpoint does

What you can build with this API method

Review the result and common workflows first, then move to parameters and a working request example.

What this endpoint helps with

The response provides a ready-to-use Search summary with key counters and metrics in the selected API format.

When to use it

Use “Pin metrics by query” for dashboards, scoring, and recurring reports that need a compact metric snapshot.

Common use cases

Product dashboards

Show core Pinterest metrics without loading and processing an entire collection.

Trend monitoring

Store periodic snapshots and compare metric changes over time.

Object scoring

Use aggregate metrics as inputs for internal rankings and rules.

Available versions

Response version

Both versions solve the same job and accept the same parameters. Use the switch to compare the response structure and choose the version your client expects.

Response version V2

Switch versions on this page to compare response structures while keeping the same documentation URL.

V1 Not available

What stays the same

Authentication, required parameters, and the request shape stay the same across V1 and V2. In practice, you choose the version when you build the endpoint path and when you parse the response.

What changes between versions

The main difference is the response envelope. Use V2 for new integrations and keep V1 only when you need compatibility with an existing client contract.

How to use it

How to call the method

Use the same API key header and the same query parameters for both versions. This documentation shows the shared parameter set first, then version-specific endpoint paths and code snippets.

Input parameters

Shared parameters

Parameter	Required	Type	Example	Description
`query`	Yes	`str`	`home decor`	User-entered search query.

Version-specific request path

V2

Choose a version when you copy the exact endpoint path, example URL, and code snippet. The parameter list above stays the same.

GET /api/v2/pinterest.com/search/pins-metrics-by-query

Normalized format

Request preview

Base URL https://www.scrapestorm.net

Endpoint /api/v2/pinterest.com/search/pins-metrics-by-query

Required parameters

query

Optional parameters

None

Example URL

https://www.scrapestorm.net/api/v2/pinterest.com/search/pins-metrics-by-query?query=home+decor

Code examples

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/pinterest.com/search/pins-metrics-by-query" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'query=home decor'

from urllib.parse import urljoin

import requests

BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/pinterest.com/search/pins-metrics-by-query"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}

params = {
    "query": "home decor",
}

with requests.Session() as session:
    response = session.request(
        method="GET",
        url=urljoin(BASE_URL, ENDPOINT),
        headers=HEADERS,
        params=params,
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()

print(payload)

const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v2/pinterest.com/search/pins-metrics-by-query";

const params = new URLSearchParams({
  query: "home decor",
});

const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const payload = await response.json();
console.log(payload);

import axios from "axios";

const client = axios.create({
  baseURL: "https://www.scrapestorm.net",
  timeout: 30000,
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

const params = {
  query: "home decor",
};

const { data: payload } = await client.request({
  method: "GET",
  url: endpoint,
  params,
});

console.log(payload);

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client([
    'base_uri' => "https://www.scrapestorm.net",
    'timeout' => 30.0,
    'headers' => [
        'Accept' => 'application/json',
        'X-API-Key' => "00000000-0000-4000-8000-000000000000",
    ],
]);

$query = [
    "query" => "home decor",
];

try {
    $response = $client->request("GET", "/api/v2/pinterest.com/search/pins-metrics-by-query", [
        'query' => $query,
    ]);

    $payload = json_decode(
        (string) $response->getBody(),
        true,
        512,
        JSON_THROW_ON_ERROR
    );

    var_dump($payload);
} catch (GuzzleException $e) {
    throw $e;
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
    "time"
)

func main() {
    baseURL := "https://www.scrapestorm.net"
    endpoint := "/api/v2/pinterest.com/search/pins-metrics-by-query"

    params := url.Values{}
    params.Set("query", "home decor")

    req, err := http.NewRequest(
        "GET",
        fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
        nil,
    )
    if err != nil {
        panic(err)
    }

    req.Header.Set("Accept", "application/json")
    req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")

    client := &http.Client{Timeout: 30 * time.Second}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload any
    if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", payload)
}

Response example

Live response by version

The preview keeps key fields and the first collection items so you can scan the response shape quickly. Switching versions changes the JSON format.

Response example

V2 response JSON

Verified example

This compact JSON example comes from the latest successful verification run for V2.

{
  "success": true,
  "status": "ok",
  "search_context": {
    "query": "home decor"
  },
  "data": {
    "analytics": {
      "all_posts": {
        "analyzed_posts_count": 9,
        "last_post_date": "2026-10-04T23:57:48+00:00",
        "total_engagement": 423,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 47.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 8.0,
        "max_engagement_per_post": 336,
        "avg_caption_length": 293,
        "avg_posts_per_week": 0,
        "avg_posts_per_month": 1,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 8,
        "total_reactions": 423,
        "total_comments": 0,
        "avg_reactions_per_post": 47,
        "avg_comments_per_post": 0,
        "total_reaction_rate": 0.0,
        "total_comment_rate": 0.0,
        "content_format_breakdown": [
          {
            "format": "pin",
            "count": 9,
            "percentage": 100.0
          }
        ],
        "posting_time_analysis": {
          "by_day_of_week": [
            {
              "day": "Sunday",
              "count": 3
            },
            {
              "day": "Thursday",
              "count": 2
            },
            {
              "_more_items": 2
            }
          ],
          "by_hour_of_day": [
            {
              "hour": 19,
              "count": 1
            },
            {
              "hour": 23,
              "count": 1
            },
            {
              "_more_items": 7
            }
          ]
        },
        "top_hashtags": [
          {
            "hashtag": "interiordesign",
            "count": 1
          },
          {
            "hashtag": "featurewall",
            "count": 1
          },
          {
            "_more_items": 3
          }
        ],
        "top_posts_by_engagement": [
          {
            "item_id": "902760687832445696",
            "pin_id": "902760687832445696",
            "url": "https://www.pinterest.com/pin/902760687832445696/",
            "title": "Hawthorne Vintage Wall Sconce | Traditional Brass Hallway Lighting",
            "text": "The Hawthorne Vintage Wall Sconce brings timeless character to hallways, entryways, and staircases. Its graceful arched arm and warm antique brass finish create beautiful layere…",
            "created_at": "2026-03-08T19:02:01+00:00",
            "content_format": "pin",
            "engagement": 336,
            "is_sponsored": false,
            "sponsored_detection_source": null,
            "sponsored_detection_confidence": null,
            "reactions": 336
          },
          {
            "item_id": "1090926709833037531",
            "pin_id": "1090926709833037531",
            "url": "https://www.pinterest.com/pin/1090926709833037531/",
            "title": "Lush Vintage Living Room with Greenery",
            "text": "Explore a cozy vintage-inspired living room filled with stylish furniture and abundant plants on shelves by a sunny window. Perfect for new homes seeking timeless home decor ide…",
            "created_at": "2026-10-04T23:57:48+00:00",
            "content_format": "pin",
            "engagement": 34,
            "is_sponsored": false,
            "sponsored_detection_source": null,
            "sponsored_detection_confidence": null,
            "reactions": 34
          },
          {
            "_more_items": 3
          }
        ],
        "_more_fields": "1 more fields"
      },
      "sponsored_posts": {
        "analyzed_posts_count": 0,
        "total_engagement": 0,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 0.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 0.0,
        "max_engagement_per_post": 0,
        "avg_caption_length": 0,
        "avg_posts_per_week": 0,
        "avg_posts_per_month": 0,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 0
      },
      "organic_posts": {
        "analyzed_posts_count": 9,
        "last_post_date": "2026-10-04T23:57:48+00:00",
        "total_engagement": 423,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 47.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 8.0,
        "max_engagement_per_post": 336,
        "avg_caption_length": 293,
        "avg_posts_per_week": 0,
        "avg_posts_per_month": 1,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 8,
        "total_reactions": 423,
        "total_comments": 0,
        "avg_reactions_per_post": 47,
        "avg_comments_per_post": 0,
        "total_reaction_rate": 0.0,
        "total_comment_rate": 0.0,
        "content_format_breakdown": [
          {
            "format": "pin",
            "count": 9,
            "percentage": 100.0
          }
        ],
        "posting_time_analysis": {
          "by_day_of_week": [
            {
              "day": "Sunday",
              "count": 3
            },
            {
              "day": "Thursday",
              "count": 2
            },
            {
              "_more_items": 2
            }
          ],
          "by_hour_of_day": [
            {
              "hour": 19,
              "count": 1
            },
            {
              "hour": 23,
              "count": 1
            },
            {
              "_more_items": 7
            }
          ]
        },
        "top_hashtags": [
          {
            "hashtag": "interiordesign",
            "count": 1
          },
          {
            "hashtag": "featurewall",
            "count": 1
          },
          {
            "_more_items": 3
          }
        ],
        "top_posts_by_engagement": [
          {
            "item_id": "902760687832445696",
            "pin_id": "902760687832445696",
            "url": "https://www.pinterest.com/pin/902760687832445696/",
            "title": "Hawthorne Vintage Wall Sconce | Traditional Brass Hallway Lighting",
            "text": "The Hawthorne Vintage Wall Sconce brings timeless character to hallways, entryways, and staircases. Its graceful arched arm and warm antique brass finish create beautiful layere…",
            "created_at": "2026-03-08T19:02:01+00:00",
            "content_format": "pin",
            "engagement": 336,
            "is_sponsored": false,
            "sponsored_detection_source": null,
            "sponsored_detection_confidence": null,
            "reactions": 336
          },
          {
            "item_id": "1090926709833037531",
            "pin_id": "1090926709833037531",
            "url": "https://www.pinterest.com/pin/1090926709833037531/",
            "title": "Lush Vintage Living Room with Greenery",
            "text": "Explore a cozy vintage-inspired living room filled with stylish furniture and abundant plants on shelves by a sunny window. Perfect for new homes seeking timeless home decor ide…",
            "created_at": "2026-10-04T23:57:48+00:00",
            "content_format": "pin",
            "engagement": 34,
            "is_sponsored": false,
            "sponsored_detection_source": null,
            "sponsored_detection_confidence": null,
            "reactions": 34
          },
          {
            "_more_items": 3
          }
        ],
        "_more_fields": "1 more fields"
      },
      "segment_comparison": {
        "sponsored_content_share": 0.0,
        "organic_content_share": 100.0,
        "organic_vs_sponsored_engagement_rate_gap": 0.0,
        "sponsored_to_organic_avg_engagement_ratio": 0.0
      }
    },
    "feed": {
      "count": 9,
      "items": [
        {
          "url": "https://www.pinterest.com/pin/902760687832445696/",
          "pin_id": "902760687832445696",
          "aggregated_pin_id": "3307276566731601152",
          "title": "Hawthorne Vintage Wall Sconce | Traditional Brass Hallway Lighting",
          "description": "The Hawthorne Vintage Wall Sconce brings timeless character to hallways, entryways, and staircases. Its graceful arched arm and warm antique brass finish create beautiful layere…",
          "link": "https://hadleyjamesathome.com/products/hawthorne-vintage-wall-sconce",
          "domain": "hadleyjamesathome.com",
          "created_at": "2026-03-08T19:02:01+00:00",
          "reaction_count": 336,
          "board": {
            "url": "https://www.pinterest.com/HadleyJamesatHome/entryway-lighting-design-ideas/",
            "board_id": "902760756496002340",
            "name": "Entryway Lighting & Design Ideas",
            "pin_count": 31,
            "collaborator_count": 0,
            "section_count": 1,
            "is_collaborative": false,
            "modified_at": "2026-09-01T15:09:06+00:00",
            "owner": {
              "url": "https://www.pinterest.com/HadleyJamesatHome/",
              "user_id": "902760825213784691",
              "username": "HadleyJamesatHome",
              "display_name": "Hadley James at Home",
              "follower_count": 404,
              "avatar_url": "https://example.com/image.jpg"
            },
            "thumbnail_url": "https://example.com/image.jpg"
          },
          "pinner": {
            "url": "https://www.pinterest.com/HadleyJamesatHome/",
            "user_id": "902760825213784691",
            "username": "HadleyJamesatHome",
            "display_name": "Hadley James at Home",
            "follower_count": 404,
            "avatar_url": "https://example.com/image.jpg"
          },
          "tags": [
            "Wall Decor Ideas Entryway",
            "Home Decor Ideas Classic",
            {
              "_more_items": 7
            }
          ],
          "dominant_color": "#a88f74",
          "thumbnail_url": "https://example.com/image.jpg",
          "images": [
            {
              "url": "https://i.pinimg.com/236x/51/16/90/511690c2692d705acee310f555cfc62f.jpg",
              "width": 236,
              "height": 354
            },
            {
              "url": "https://i.pinimg.com/474x/51/16/90/511690c2692d705acee310f555cfc62f.jpg",
              "width": 474,
              "height": 711
            },
            {
              "_more_items": 2
            }
          ],
          "is_sponsored": false,
          "sponsored_detection_source": null,
          "sponsored_detection_confidence": null
        },
        {
          "url": "https://www.pinterest.com/pin/1090926709833037531/",
          "pin_id": "1090926709833037531",
          "aggregated_pin_id": "3875886895133724096",
          "title": "Lush Vintage Living Room with Greenery",
          "description": "Explore a cozy vintage-inspired living room filled with stylish furniture and abundant plants on shelves by a sunny window. Perfect for new homes seeking timeless home decor ide…",
          "domain": "Uploaded by user",
          "created_at": "2026-10-04T23:57:48+00:00",
          "reaction_count": 34,
          "board": {
            "url": "https://www.pinterest.com/vedikasrivas21/_quick_saves/",
            "board_id": "1090926778427494527",
            "name": "Quick saves",
            "pin_count": 40,
            "collaborator_count": 0,
            "section_count": 0,
            "is_collaborative": false,
            "modified_at": "2026-10-05T00:04:10+00:00",
            "owner": {
              "url": "https://www.pinterest.com/vedikasrivas21/",
              "user_id": "1090926847145206354",
              "username": "vedikasrivas21",
              "display_name": "Vedika",
              "follower_count": 0,
              "avatar_url": "https://example.com/image.jpg"
            },
            "thumbnail_url": "https://example.com/image.jpg"
          },
          "pinner": {
            "url": "https://www.pinterest.com/vedikasrivas21/",
            "user_id": "1090926847145206354",
            "username": "vedikasrivas21",
            "display_name": "Vedika",
            "follower_count": 0,
            "avatar_url": "https://example.com/image.jpg"
          },
          "tags": [
            "Vintage Living Room",
            "Plant Shelves",
            {
              "_more_items": 7
            }
          ],
          "dominant_color": "#8c704c",
          "thumbnail_url": "https://example.com/image.jpg",
          "images": [
            {
              "url": "https://i.pinimg.com/236x/25/5e/bd/255ebd8c6055c12e3eb1222da91d362a.jpg",
              "width": 236,
              "height": 419
            },
            {
              "url": "https://i.pinimg.com/474x/25/5e/bd/255ebd8c6055c12e3eb1222da91d362a.jpg",
              "width": 474,
              "height": 842
            },
            {
              "_more_items": 2
            }
          ],
          "is_sponsored": false,
          "sponsored_detection_source": null,
          "sponsored_detection_confidence": null
        },
        {
          "_more_items": 7
        }
      ]
    }
  }
}

Related methods

Continue working with Search

Adjacent methods let you resolve the same object with another identifier, open details, or move to an aggregate view.

What to do next

Continue the evaluation

Use this documentation as the first decision point, then move into pricing, platform coverage, and integration rules before you connect the endpoint for recurring use.

Open the Pinterest platform page

Compare adjacent entities, API method groups, and related docs before implementation.

Open platform page

Compare API method pricing

Check where this API method sits inside the public price table before you scale usage.

View pricing

Review integration rules

Use the starter docs to confirm authentication, versioning, retries, and mock vs live behavior.

Open docs

FAQ

Questions teams ask before implementation

Use these answers to decide whether this API method fits your workflow, versioning choice, and rollout plan.

What data does this Pinterest API method return?

The method performs “Pin metrics by query” for Search. The compact response example below shows the exact field structure.

Should I choose V1 or V2?

Choose V2 for new integrations because it provides a normalized structure. Use V1 only for compatibility with clients that already consume the platform-native format.

What do I need for the first request?

Create an API key, send it in the request header, and provide the required parameters from the table. The code samples already contain the correct path and request structure.