このエンドポイントが役立つこと
レスポンスは、選択した API 形式で、カウンターと主要な指標を含むすぐに使える 検索 の概要を提供します。
使用に適した場面
指標のコンパクトなスナップショットが必要なダッシュボード、評価、定期レポートで「検索クエリによるピンの指標」を使用します。
まず結果と一般的なワークフローを確認し、次にパラメーターと動作するリクエスト例に進んでください。
レスポンスは、選択した API 形式で、カウンターと主要な指標を含むすぐに使える 検索 の概要を提供します。
指標のコンパクトなスナップショットが必要なダッシュボード、評価、定期レポートで「検索クエリによるピンの指標」を使用します。
コレクション全体を読み込んで処理することなく、Pinterest の主要な指標を表示します。
定期的なスナップショットを保存し、指標の推移を比較します。
集計指標をランキングや社内ルールの入力として使用します。
どちらのバージョンも同じタスクを解決し、同じパラメーターを受け付けます。切り替えを使ってレスポンス構造を比較し、クライアントが想定するバージョンを選んでください。
このページでバージョンを切り替えると、同じドキュメント URL でレスポンス構造を比較できます。
認証、必須パラメーター、リクエストの形は V1 と V2 で同じです。実際には、エンドポイントのパスを組み立てるときとレスポンスを読み取るときにバージョンを選びます。
主な違いはレスポンスのエンベロープです。新しい連携では V2 を使用し、既存のクライアント契約との互換性が必要な場合にのみ V1 を残してください。
どちらのバージョンでも、同じ API キーのヘッダーと同じクエリパラメーターを使用します。このドキュメントでは、まず共通のパラメーターを示し、次に各バージョンのパスとコードスニペットを示します。
| パラメーター | 必須 | 型 | 例 | 説明 |
|---|---|---|---|---|
query |
はい | str |
home decor |
ユーザーが入力した検索クエリ。 |
エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。
GET /api/v2/pinterest.com/search/pins-metrics-by-querycurl --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)
}
プレビューには主要なフィールドとコレクションの最初の要素が含まれているため、レスポンスの形をすばやく確認できます。バージョンを切り替えると JSON の形式が変わります。
このコンパクトな JSON の例は、V2 の直近の成功した検証実行から取得したものです。
{
"success": true,
"status": "ok",
"search_context": {
"query": "home decor"
},
"data": {
"analytics": {
"all_posts": {
"analyzed_posts_count": 7,
"last_post_date": "2026-07-07T20:19:53+00:00",
"total_engagement": 6202,
"avg_engagement_rate_per_post": 0.0,
"peak_engagement_rate_per_post": 0.0,
"avg_weighted_engagement_score": 886.0,
"total_engagement_rate": 0.0,
"median_engagement_per_post": 79.0,
"max_engagement_per_post": 4178,
"avg_caption_length": 338,
"avg_posts_per_week": 0,
"avg_posts_per_month": 0,
"posts_count_last_7_days": 0,
"posts_count_last_30_days": 2,
"total_reactions": 6202,
"total_comments": 0,
"avg_reactions_per_post": 886,
"avg_comments_per_post": 0,
"total_reaction_rate": 0.0,
"total_comment_rate": 0.0,
"content_format_breakdown": [
{
"format": "pin",
"count": 7,
"percentage": 100.0
}
],
"posting_time_analysis": {
"by_day_of_week": [
{
"day": "Tuesday",
"count": 3
},
{
"day": "Monday",
"count": 2
},
{
"_more_items": 2
}
],
"by_hour_of_day": [
{
"hour": 14,
"count": 2
},
{
"hour": 0,
"count": 2
},
{
"_more_items": 2
}
]
},
"top_hashtags": [
{
"hashtag": "floatingshelves",
"count": 1
},
{
"hashtag": "cornerdecor",
"count": 1
},
{
"_more_items": 8
}
],
"top_mentioned_users": [
{
"username": "ladyofbookshire",
"count": 1
}
],
"_more_fields": "2 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": 7,
"last_post_date": "2026-07-07T20:19:53+00:00",
"total_engagement": 6202,
"avg_engagement_rate_per_post": 0.0,
"peak_engagement_rate_per_post": 0.0,
"avg_weighted_engagement_score": 886.0,
"total_engagement_rate": 0.0,
"median_engagement_per_post": 79.0,
"max_engagement_per_post": 4178,
"avg_caption_length": 338,
"avg_posts_per_week": 0,
"avg_posts_per_month": 0,
"posts_count_last_7_days": 0,
"posts_count_last_30_days": 2,
"total_reactions": 6202,
"total_comments": 0,
"avg_reactions_per_post": 886,
"avg_comments_per_post": 0,
"total_reaction_rate": 0.0,
"total_comment_rate": 0.0,
"content_format_breakdown": [
{
"format": "pin",
"count": 7,
"percentage": 100.0
}
],
"posting_time_analysis": {
"by_day_of_week": [
{
"day": "Tuesday",
"count": 3
},
{
"day": "Monday",
"count": 2
},
{
"_more_items": 2
}
],
"by_hour_of_day": [
{
"hour": 14,
"count": 2
},
{
"hour": 0,
"count": 2
},
{
"_more_items": 2
}
]
},
"top_hashtags": [
{
"hashtag": "floatingshelves",
"count": 1
},
{
"hashtag": "cornerdecor",
"count": 1
},
{
"_more_items": 8
}
],
"top_mentioned_users": [
{
"username": "ladyofbookshire",
"count": 1
}
],
"_more_fields": "2 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": 7,
"items": [
{
"url": "https://www.pinterest.com/pin/225039312627881892/",
"pin_id": "225039312627881892",
"aggregated_pin_id": "5263188580060150572",
"title": "Cozy Reading Nook",
"description": "Neva Round Daybed in Recycled Faux Fur color: Pampas Grass Featured on Instagram @ladyofbookshire",
"link": "https://sixpenny.com/products/neva-round-daybed-slipcover-only?currency=USD&variant=40241699946540&utm_medium=cpc&utm_source=google&utm_campaign=Google+Shopping&gclid=EAIaIQobCh…",
"domain": "sixpenny.com",
"created_at": "2022-11-05T14:37:02+00:00",
"reaction_count": 1616,
"board": {
"url": "https://www.pinterest.com/erinturnage/reading-room-inspo/",
"board_id": "225039381319533959",
"name": "Reading Room Inspo",
"pin_count": 4,
"collaborator_count": 0,
"section_count": 0,
"is_collaborative": false,
"modified_at": "2023-02-10T03:09:22+00:00",
"owner": {
"url": "https://www.pinterest.com/erinturnage/",
"user_id": "225039450038600465",
"username": "erinturnage",
"display_name": "Erin Turnage",
"follower_count": 87,
"avatar_url": "https://example.com/image.jpg"
},
"thumbnail_url": "https://example.com/image.jpg"
},
"pinner": {
"url": "https://www.pinterest.com/erinturnage/",
"user_id": "225039450038600465",
"username": "erinturnage",
"display_name": "Erin Turnage",
"follower_count": 87,
"avatar_url": "https://example.com/image.jpg"
},
"tags": [
"Home Living Room",
"Dream House Decor",
{
"_more_items": 7
}
],
"dominant_color": "#6c5942",
"thumbnail_url": "https://example.com/image.jpg",
"images": [
{
"url": "https://i.pinimg.com/236x/2c/24/91/2c24917f5d44c73a48b10de4692f3467.jpg",
"width": 236,
"height": 445
},
{
"url": "https://i.pinimg.com/474x/2c/24/91/2c24917f5d44c73a48b10de4692f3467.jpg",
"width": 474,
"height": 895
},
{
"_more_items": 2
}
],
"is_sponsored": false,
"sponsored_detection_source": null,
"sponsored_detection_confidence": null
},
{
"url": "https://www.pinterest.com/pin/696439529923803956/",
"pin_id": "696439529923803956",
"aggregated_pin_id": "3159035064123023616",
"title": "🌸 Finally—a fluffy rug that doesn't shed everywhere",
"description": "Your Room Deserves This Kind of Soft You know that feeling when you walk into a room and it just feels... right? Warm. Put-together. Like someone actually thought about it. Tha…",
"link": "https://clarendale.co/products/velura%E2%84%A2-gradient-plush-rug-for-cozy-rooms?utm_campaign=626757503084&utm_ad_group=2680088796241&utm_ad=687300955419&utm_source=pinterest&pp=1",
"domain": "clarendale.co",
"created_at": "2026-07-06T00:25:51+00:00",
"reaction_count": 4178,
"board": {
"url": "https://www.pinterest.com/Io_Gabriiiell_A/deco/",
"board_id": "696439598566996202",
"name": "DECO",
"pin_count": 58,
"collaborator_count": 0,
"section_count": 0,
"is_collaborative": false,
"modified_at": "2026-07-16T02:20:40+00:00",
"owner": {
"url": "https://www.pinterest.com/Io_Gabriiiell_A/",
"user_id": "696439667284860054",
"username": "Io_Gabriiiell_A",
"display_name": "IO Gabriiiell ∆",
"follower_count": 10,
"avatar_url": "https://example.com/image.jpg"
},
"thumbnail_url": "https://example.com/image.jpg"
},
"pinner": {
"url": "https://www.pinterest.com/Io_Gabriiiell_A/",
"user_id": "696439667284860054",
"username": "Io_Gabriiiell_A",
"display_name": "IO Gabriiiell ∆",
"follower_count": 10,
"avatar_url": "https://example.com/image.jpg"
},
"tags": [
"Rug Color",
"Thick Rug",
{
"_more_items": 7
}
],
"dominant_color": "#796557",
"thumbnail_url": "https://example.com/image.jpg",
"images": [
{
"url": "https://i.pinimg.com/236x/3c/b7/b0/3cb7b0c54787ae270cb3178ddc5bebcd.jpg",
"width": 236,
"height": 354
},
{
"url": "https://i.pinimg.com/474x/3c/b7/b0/3cb7b0c54787ae270cb3178ddc5bebcd.jpg",
"width": 474,
"height": 711
},
{
"_more_items": 2
}
],
"is_sponsored": false,
"sponsored_detection_source": null,
"sponsored_detection_confidence": null
},
{
"_more_items": 5
}
]
}
}
}
このドキュメントを最初の判断材料とし、継続的な利用のためにエンドポイントを接続する前に、料金、プラットフォームのカバー範囲、連携ルールを確認してください。
これらの回答を参考に、この API メソッドがワークフロー、バージョンの選択、導入計画に合うかどうかを判断してください。
このメソッドは 検索 に対して「検索クエリによるピンの指標」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。
新しい連携では、正規化された構造を提供する V2 を選んでください。V1 は、既にプラットフォーム固有の形式を処理しているクライアントとの互換性のためにのみ使用してください。
API キーを作成し、リクエストヘッダーで送信し、表の必須パラメーターを指定してください。コード例には、正しいパスとリクエスト構造が既に含まれています。