GET
/api/v4/social/posts/{postId}/insights投稿のインサイトとコメントを取得する
接続済みの1つのチャネルで公開された1つの投稿について、プラットフォーム独自のエンゲージメントペイロードとコメントを返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| postId | string | 必須 | Post UUID, the `socialPostId` returned by POST /social/posts. |
クエリ
| 名前 | 型 | 必須 | 説明 | デフォルト |
|---|---|---|---|---|
| socialConnectedChannelId | string | 必須 | UUID of the connection to read insights for, the `id` of a row from the brand's connections list. Insights are per channel, so this is required even when the post targeted one platform. Note the name: this endpoint takes `socialConnectedChannelId`, while disconnect takes `socialProfileConnectedChannelId` for the same ID. | — |
レスポンス
200The platform's engagement payload and comments. Both fields are JSON strings whose keys are set by the platform, not by Listings API: parse them before reading.
{ "data": { "getPostInsightsAndCommentsForSocialChannel": { "insights": "{\"impressions\": 4820, \"reach\": 3915, \"likes\": 212, \"comments\": 18, \"saved\": 44, \"shares\": 9, \"profile_visits\": 61}", "comments": "[{\"id\": \"17912345678901234\", \"username\": \"marta.builds\", \"text\": \"That oak finish is beautiful. Do you ship?\", \"like_count\": 3, \"timestamp\": \"2026-10-02T15:12:44+0000\"}, {\"id\": \"17912345678905678\", \"username\": \"eastsidehome\", \"text\": \"Stopping by Saturday!\", \"like_count\": 0, \"timestamp\": \"2026-10-02T18:40:02+0000\"}]" } }}401Unauthenticated, missing or invalid API key.
404No post with that ID on this account, or the connection does not belong to the post's brand (`SY95052`).
1つのチャネルで公開された1つの投稿について、プラットフォームが報告する情報、つまりエンゲージメント指標とその投稿に寄せられたコメントを返します。
ユースケース:投稿ごとのエンゲージメントパネル。 顧客がUIで公開済みの投稿を開いたら、GET /social/posts/{postId}を呼び出してチャネル一覧を取得し、各チャネルのidを指定して、このエンドポイントをチャネルごとに1回呼び出します。insightsをパースし、認識できる指標を表示して、それ以外は無視してください。そうすることで、プラットフォームがフィールドを追加してもページが壊れることはありません。
ユースケース:返信が必要なコメントの抽出。 最近公開された投稿についてこのエンドポイントをポーリングし、パースしたcomments配列の新しいエントリを独自の受信トレイに振り分けます。このエンドポイントは読み取り専用であることに注意してください。コメントへの返信はListings API経由ではなく、プラットフォーム上で行います。
注意事項。
socialConnectedChannelIdは必須であり、プラットフォームのreferenceIdではなく、ブランドの接続から取得した接続のidです。数値はそのプラットフォームのAPIから取得されるため、インサイトの対象範囲は常に1つのチャネルです。- チャネルは投稿と同じブランドに属している必要があります。投稿を別のブランドの接続と組み合わせると、
SY95052が返されます。 - インサイトがあるのは公開済みの投稿のみです。 まだ
SCHEDULEDの投稿、またはこのチャネルで公開に失敗した投稿では、エラーではなく空のペイロードが返されるため、結論を出す前に投稿のconnectedChannels[].statusを確認してください。 - 指標の鮮度はプラットフォームの更新頻度に依存し、ほとんどのプラットフォームでは公開後、数分から数時間の遅延があります。
connectedChannels[].statusがSUCCESSに変わった直後に数値が得られると期待するのではなく、タイマーで定期的にポーリングしてください。 - コメントの取得件数は、プラットフォームが1ページで返す件数が上限です。このエンドポイントは、それ以降のページを取得しません。
Request
curl -X GET 'https://listingsapi.com/api/v4/social/posts/<postId>/insights?socialConnectedChannelId=<socialConnectedChannelId>' \ -H "Authorization: API $LISTINGSAPI_KEY"