Listings APIListings API
Masuk
GET/api/v4/social/posts/{postId}/insights

Dapatkan wawasan dan komentar postingan

Mengembalikan payload interaksi milik platform dan komentar untuk satu postingan yang telah dipublikasikan di satu kanal yang terhubung.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Path

NamaTipeWajibDeskripsi
postIdstringwajibPost UUID, the `socialPostId` returned by POST /social/posts.

Query

NamaTipeWajibDeskripsiDefault
socialConnectedChannelIdstringwajibUUID 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.—

Respons

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.
Response
{  "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`).

Mengembalikan informasi yang dilaporkan platform tentang satu postingan yang telah dipublikasikan di satu kanal: metrik interaksinya dan komentar yang ditinggalkan pada postingan tersebut.

Kasus penggunaan: panel interaksi per postingan. Saat pelanggan membuka postingan yang telah dipublikasikan di UI Anda, panggil GET /social/posts/{postId} untuk mendapatkan daftar kanal, lalu panggil endpoint ini satu kali per kanal dengan id kanal tersebut. Parse insights, tampilkan metrik yang Anda kenali, dan abaikan sisanya — dengan begitu, penambahan field oleh platform tidak akan merusak halaman Anda.

Kasus penggunaan: menampilkan komentar yang perlu dibalas. Lakukan polling pada endpoint ini untuk postingan yang baru dipublikasikan dan arahkan entri baru dari array comments yang telah di-parse ke kotak masuk Anda sendiri. Perhatikan bahwa endpoint ini hanya dapat digunakan untuk membaca: membalas komentar dilakukan di platform, bukan melalui Listings API.

Catatan.

  • socialConnectedChannelId wajib diisi, dan nilainya adalah id milik koneksi dari koneksi merek tersebut — bukan referenceId milik platform. Wawasan selalu terbatas pada satu kanal karena angkanya berasal dari API platform tersebut.
  • Kanal harus dimiliki oleh merek yang sama dengan postingan. Memasangkan postingan dengan koneksi merek lain akan membuat endpoint mengembalikan SY95052.
  • Hanya postingan yang telah dipublikasikan yang memiliki wawasan. Postingan yang masih berstatus SCHEDULED, atau yang gagal dipublikasikan di kanal ini, akan menghasilkan payload kosong, bukan error, jadi periksa connectedChannels[].status pada postingan sebelum menarik kesimpulan.
  • Keterkinian metrik bergantung pada pembaruan dari platform, yang pada sebagian besar platform berarti ada jeda beberapa menit hingga beberapa jam setelah publikasi. Lakukan polling secara berkala, alih-alih mengharapkan angka tersedia segera setelah connectedChannels[].status berubah menjadi SUCCESS.
  • Jumlah komentar dibatasi oleh jumlah yang dikembalikan platform dalam satu halaman; endpoint ini tidak mengambil halaman berikutnya.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/posts/<postId>/insights?socialConnectedChannelId=<socialConnectedChannelId>' \  -H "Authorization: API $LISTINGSAPI_KEY"
Run in playground