ブランド

curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "group_by": ["date"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "scope": "owned",
    "limit": 10
  }'

{
  "info": {
    "total_results": 1,
    "count": 1,
    "next_cursor": null,
    "scope": "owned",
    "assets": null,
    "models": ["ChatGPT"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "filter": null
  },
  "data": [
    {
      "asset": { "name": "Example Brand", "owned": true },
      "date": "2026-06-01",
      "visibility_score": 0.42,
      "average_position": 3.2,
      "visibility_rank": 1
    }
  ]
}

POST

reports

shopping

brands

curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "group_by": ["date"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "scope": "owned",
    "limit": 10
  }'

{
  "info": {
    "total_results": 1,
    "count": 1,
    "next_cursor": null,
    "scope": "owned",
    "assets": null,
    "models": ["ChatGPT"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "filter": null
  },
  "data": [
    {
      "asset": { "name": "Example Brand", "owned": true },
      "date": "2026-06-01",
      "visibility_score": 0.42,
      "average_position": 3.2,
      "visibility_rank": 1
    }
  ]
}

このレポートは、ChatGPT のショッピング結果におけるブランドの可視性を示します。各ブランドが表示される頻度、平均順位、ランクがわかります。ブランドは assets で選択します。結果は group_by で分割します。各指標は行内の名前付きフィールドとして返されます。

指標: visibility_score (そのブランドを含むショッピング結果の割合)、average_position (ブランドが表示されたときの平均順位。数値が低いほど良い)、visibility_rank。
group_by: date、topic、region、または prompt。
ブランドの選択: assets パラメータでブランドを選択します。名前を 1 つ、またはリストで指定します。scope: "all" はすべてのブランドをランク付けします。scope: "owned" (デフォルト) は自社ブランドのみを返します。assets で選択した場合は 1 ページのみが返され、limit は無視されます。
フィルタフィールド: topic、region、persona、prompt、tag。

ショッピングデータは ChatGPT のみから取得されます。ショッピングレポートには model の group_by や model フィルタはありません。

v2 レポートは共通のリクエスト形式を使用します。フィルタツリー、グループ化、ページネーションについては、フィルタリングと概念を参照してください。

ストリーミング (SSE) バリアント (同じボディ、/stream)

POST /v2/reports/shopping/brands/stream は 同じリクエストボディ を使用します。 Server-Sent Events を返し、まず 1 つの summary イベント (info ブロック) が送信され、続いて行ごとに 1 つの result イベントが送信されます。ストリームは limit と cursor を受け付けません。デフォルトではすべての行が返されます。上限を設定するには max_results (最大 50000) を使用します。大きな結果を 1 回のリクエストで取得するにはストリームを使用してください。

curl -X POST https://api.tryprofound.com/v2/reports/shopping/brands \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "category_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "group_by": ["date"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "scope": "owned",
    "limit": 10
  }'

{
  "info": {
    "total_results": 1,
    "count": 1,
    "next_cursor": null,
    "scope": "owned",
    "assets": null,
    "models": ["ChatGPT"],
    "metrics": ["visibility_score", "average_position", "visibility_rank"],
    "start_date": "2026-06-01",
    "end_date": "2026-06-30",
    "filter": null
  },
  "data": [
    {
      "asset": { "name": "Example Brand", "owned": true },
      "date": "2026-06-01",
      "visibility_score": 0.42,
      "average_position": 3.2,
      "visibility_rank": 1
    }
  ]
}

承認

X-API-Key

string

header

必須

ボディ

application/json

category_id

string<uuid>

必須

start_date

string

必須

YYYY-MM-DD, ET, inclusive

end_date

string

必須

YYYY-MM-DD, ET, inclusive

group_by

enum<string>[]

利用可能なオプション:

date,

topic,

region,

prompt

metrics

enum<string>[] | null

利用可能なオプション:

visibility_score,

average_position,

visibility_rank

interval

enum<string>

デフォルト:day

利用可能なオプション:

day,

week,

month

scope

enum<string>

デフォルト:owned

利用可能なオプション:

owned,

all

assets

Restrict to these asset names (a name or list). Overrides scope.

filter

FilterNode · object | null

A leaf (field/op/value) or an and/or/not group.

Show child attributes

limit

integer | null

Page size for scope=all; default 10, max 50.

必須範囲: 0 < x <= 50

max_results

integer | null

Stream endpoint only: cap the number of streamed rows (default: all).

必須範囲: 0 < x <= 50000

cursor

string | null

レスポンス

Successful Response

info

ShoppingBrandsV2Info · object

必須

Show child attributes

data

ShoppingBrandRow · object[]

必須

Show child attributes

はじめに

API リファレンス

インテグレーション

SDK

承認

ボディ

レスポンス