拠点の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.

Response

{  "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: ページのCTAボタンのクリック数
directionsAction: ページ経由のルート検索リクエスト数
phoneAction: ページからの発信数
websiteAction: ページからウェブサイトへのクリック数

パスではどちらのid形式も使用可能

他のアナリティクスエンドポイントと同様に、facebook-analyticsはBase64形式のRelay id（TG9jYXRpb246MTgwMDI4OQ==）または数値のid（1800289）を受け取り、どちらも同じ拠点を参照します。読み取りエンドポイントが返すRelay idの使用を推奨します。どちらにも該当しない値を指定すると、200ステータスとともに{"data":{"facebookInsights":null},"errors":[...]}を返します。

Shell

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ボタンによるエンゲージメントの測定

拠点がページに「今すぐ予約」または「今すぐ電話」のCTAを設置している場合、ctaActionとphoneActionを使用して、キャンペーン期間中にそのボタンから発生したクリック数を把握できます。ページに指定範囲のデータがない場合、またはページが接続されていない場合は、すべての指標が（空の配列ではなく）nullとして返されることに注意し、反復処理の前にnullかどうかを確認してください。GoogleおよびBingのアナリティクスと組み合わせて、複数の掲載先の実績を1つの画面にまとめられます。