GET
/api/v4/posts/{postId}取得貼文
傳回單一社群貼文活動,包含其內容、各網站的發布狀態及互動分析資料。
參數
路徑
| 名稱 | 類型 | 必填 | 說明 |
|---|---|---|---|
| postId | string | 必填 | Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts). |
回應
200The post's content, publish details, and analytics.
{ "data": { "socialPostView": { "socialPostId": "U29jaWFsUG9zdDo0NDEyMg==", "socialPostInfo": { "id": "U29jaWFsUG9zdDo0NDEyMg==", "name": "Summer Hours Update", "status": "SUCCESS", "type": "ANNOUNCEMENT", "createdAt": "2026-06-28", "scheduledStartDate": "2026-06-28", "scheduledEndDate": "2026-07-28", "views": 128, "clicks": 14, "shares": 0, "reactions": 3, "comments": 1, "sites": ["GOOGLE"], "message": [ { "site": "GOOGLE", "message": "We have extended our summer hours! Open until 9pm on weekdays." } ], "cta": [ { "type": { "value": "LEARN_MORE", "label": "Learn more" }, "url": "https://jennyhome.example/hours", "site": "GOOGLE", "tinyUrl": "https://tiny.cc/jh-hours" } ], "contextInfo": null, "mediaUrl": [ { "url": "https://cdn.listingsapi.com/posts/44122/summer.jpg", "site": "GOOGLE", "type": "IMAGE" } ], "publishDetails": [ { "site": "GOOGLE", "status": "PUBLISHED", "createdDate": "2026-06-28", "publishedDate": "2026-06-28", "submissionError": null } ], "postLinks": [ { "site": "GOOGLE", "link": "https://www.google.com/maps/place/?post=44122" } ], "locationIds": [1800289] }, "publishedLocationsCount": 1, "socialPostAnalyticsBySite": [ { "site": "GOOGLE", "views": 128, "clicks": 14, "reactions": 3, "shares": 0, "comments": 1 } ], "socialPostAnalyticsByLocationId": [ { "locationId": 1800289, "siteStats": [ { "site": "GOOGLE", "status": "PUBLISHED", "views": 128, "clicks": 14, "reactions": 3, "shares": 0, "comments": 1 } ] } ] } }}401Unauthenticated, missing or invalid API key.
依 ID 擷取單一貼文活動,包含各網站的訊息與 CTA、附加的媒體、各網站的即時發布狀態(publishDetails),以及分別依網站(socialPostAnalyticsBySite)和依地點(socialPostAnalyticsByLocationId)細分的互動資料。
使用案例:發布後驗證。使用 POST /posts 建立公告後,立即使用傳回的 socialPost.id 輪詢 GET /posts/{postId},直到 socialPostInfo.status 從 INPROGRESS 變為 SUCCESS。如果某個網站發布失敗,publishDetails[].submissionError 會包含原因,publishDetails[].status 則會顯示 ERROR。
使用案例:互動儀表板。對於單一地點的貼文,讀取 socialPostAnalyticsBySite 即可呈現 Google 與 Facebook 的瀏覽次數和點擊次數比較,無須重新列出整個地點的貼文。
注意事項。
postId是經過 Base64 編碼的 ID,在貼文清單中以id顯示,或在建立回應中以socialPost.id顯示,並非原始整數。- 若要擷取多地點(大量)活動,請使用
GET /bulk-posts/{postId},其傳回資料的結構相同,並包含publishedLocationsCount > 1。
此範例是根據 API 結構描述建立的。實際環境中的範例帳戶(Jenny Home)沒有任何貼文,因此沒有可供擷取的真實貼文 ID;使用未知或無效的 ID 會傳回 {"data":null,"errors":[{"message":"An error occurred processing your request."}]}。
Request
curl -X GET 'https://listingsapi.com/api/v4/posts/<postId>' \ -H "Authorization: API $LISTINGSAPI_KEY"