GET
/api/v4/locations/{locationId}/facebook-analytics取得地點的 Facebook 分析資料
傳回地點在指定日期範圍內的每日 Facebook 粉絲專頁互動指標。
參數
路徑
| 名稱 | 類型 | 必填 | 說明 |
|---|---|---|---|
| locationId | string | 必填 | Location ID, either the Base64 Relay id (e.g. TG9jYXRpb246MTgwMDI4OQ==) or the raw numeric database id (e.g. 1800289). Both forms resolve to the same location. |
查詢
| 名稱 | 類型 | 必填 | 說明 | 預設值 |
|---|---|---|---|---|
| fromDate | string | 選填 | Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted. | — |
| toDate | string | 選填 | End of the range (YYYY-MM-DD). | — |
回應
200Daily Facebook Page interaction metrics. Each metric is a time-series array; a metric is `null` when no data exists for the range or the Page is not connected.
{ "data": { "facebookInsights": { "views": [ { "startTime": "2025-06-01T00:00:00+00:00", "value": 120 } ], "ctaAction": [ { "startTime": "2025-06-01T00:00:00+00:00", "value": 5 } ], "directionsAction": [ { "startTime": "2025-06-01T00:00:00+00:00", "value": 3 } ], "phoneAction": [ { "startTime": "2025-06-01T00:00:00+00:00", "value": 2 } ], "websiteAction": [ { "startTime": "2025-06-01T00:00:00+00:00", "value": 9 } ] } }}401Unauthenticated, missing or invalid API key.
傳回地點的每日 Facebook 粉絲專頁互動資料。每個指標都是由時間序列資料點組成的陣列,每個資料點包含 startTime(按日分組的日期)和 value。該地點的 Facebook 粉絲專頁必須已連結。
可用指標:
views:粉絲專頁總瀏覽次數ctaAction:粉絲專頁行動呼籲按鈕的點擊次數directionsAction:透過粉絲專頁提出的路線查詢次數phoneAction:從粉絲專頁撥打電話的次數websiteAction:從粉絲專頁點擊前往網站的次數
路徑中可使用任一種 id 格式
與其他分析端點相同,facebook-analytics 接受 Base64 Relay id(TG9jYXRpb246MTgwMDI4OQ==)或原始數字 id(1800289),兩者皆會解析至同一個地點。建議優先使用 Relay id,因為讀取端點傳回的就是這種 id。若提供的值不屬於這兩種格式,端點會傳回 {"data":{"facebookInsights":null},"errors":[...]},狀態碼為 200。
curl -s 'https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/facebook-analytics?fromDate=2025-06-01&toDate=2025-06-30' \ -H "Authorization: API $LISTINGSAPI_KEY"將互動歸因於 CTA 按鈕
當地點在其粉絲專頁上使用「立即預約」或「立即致電」行動呼籲時,您可以透過 ctaAction 和 phoneAction 量化該按鈕在活動期間帶來多少次這類點擊。請注意,當粉絲專頁在該日期範圍內沒有資料或尚未連結時,每個指標都會傳回 null(而非空陣列),因此請在逐一處理陣列元素前檢查是否為 null。結合 Google 和 Bing 分析資料,即可建立整合多個發布平台成效的單一檢視畫面。
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/facebook-analytics' \ -H "Authorization: API $LISTINGSAPI_KEY"