分析
すべてのプロフィール分析エンドポイントと、cURL、Python、Node のサンプル：拠点の Google と Facebook の日次指標、および Bing の週次閲覧数を取得します。
プロフィール分析では、各掲載先で拠点が表示された頻度と、ユーザーがアクションを起こした頻度を、表示回数、ページ閲覧数、ルート検索数、通話数、ウェブサイトのクリック数で確認できます。エンドポイントは掲載先ごとに 1 つ、合計 3 つあり、いずれも読み取り操作なので、Read（読み取り）キーで十分です。各指標は { startTime, value } ポイントの時系列データです。API は単一の合計値を返さないため、表示する合計値はクライアント側で計算します。
エンドポイントの一覧
3 つのエンドポイントはすべて同じパラメーターを使用します。fromDate と toDate は YYYY-MM-DD で、どちらも省略可能です。省略すると、掲載先のデフォルトの直近期間が使用されます。パスには base64 形式の Relay id または通常の数値を指定できます。どちらでもない値を指定すると、insights オブジェクトが null に設定され、errors 配列を伴う 200 が返されますが、これはプロフィールが未接続の場合と同じように見えるため、まず errors を確認してください。
指定した日付範囲の Google 指標を読み取る
GET /locations/{locationId}/google-analytics は、指標ごとに 1 つの日次系列を含む data.googleInsights を返します。total はプロフィールの表示回数で、search と maps の合計です。アクションの指標は含まれません。データ変更の前後で表示状況を比較するレポートに使用してください。
curl "https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/google-analytics?fromDate=2026-08-01&toDate=2026-08-31" \-H "Authorization: API $LISTINGSAPI_KEY"{ "data": { "googleInsights": { "total": [ { "startTime": "2026-08-01T00:00:00+00:00", "value": 412 }, { "startTime": "2026-08-02T00:00:00+00:00", "value": 388 } ], "search": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 300 }], "maps": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 112 }], "directionsAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 24 }], "phoneAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 8 }], "websiteAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 41 }], "businessBookings": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 0 }], "businessFoodOrders": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 0 }], "businessFoodMenuClicks": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 0 }] } }}各ポイントの startTime は、その件数が集計される日付です。サンプルでは、初日の total は 412 で、search の 300 と maps の 112 の合計です。
対象期間に拠点の Google データがない場合、または拠点の Google プロフィールが接続されていない場合、指標は空の配列ではなく null になります。集計時は、null と [] を同じように扱ってください。
指定した日付範囲の Facebook 指標を読み取る
GET /locations/{locationId}/facebook-analytics は、data.facebookInsights の下に 5 種類の日次系列を持つ同じ構造です。拠点の Facebook ページが接続されている必要があります。キャンペーン期間中の「今すぐ予約」や「今すぐ電話」ボタンの指標を測定するには、ctaAction を使用します。
curl "https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/facebook-analytics?fromDate=2026-08-01&toDate=2026-08-31" \-H "Authorization: API $LISTINGSAPI_KEY"{ "data": { "facebookInsights": { "views": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 120 }], "ctaAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 5 }], "directionsAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 3 }], "phoneAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 2 }], "websiteAction": [{ "startTime": "2026-08-01T00:00:00+00:00", "value": 9 }] } }}ページの「いいね！」数の指標はありません。対象範囲のページデータがない場合、またはページが接続されていない場合、すべての系列が null として返されるため、反復処理を行う前に null かどうかを確認してください。
指定した日付範囲の Bing 閲覧数を読み取る
GET /locations/{locationId}/bing-analyticsは、日単位ではなく週単位で集計された単一の系列data.bingInsights.viewsを返します。各データポイントは、startTimeから始まる1週間の閲覧数です。データは毎週月曜日に前週分が更新されるため、表示される最新のデータは、直近の完了した週のデータです。傾向を線で示すには、複数月にわたる範囲を取得してください。日単位の効果測定には適していません。
curl "https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/bing-analytics?fromDate=2026-06-01&toDate=2026-08-31" \-H "Authorization: API $LISTINGSAPI_KEY"{ "data": { "bingInsights": { "views": [ { "startTime": "2026-06-01T00:00:00+00:00", "value": 73 }, { "startTime": "2026-06-08T00:00:00+00:00", "value": 58 } ] } }}GoogleやFacebookとは異なり、Bingはデータがない場合、nullではなく、200と空のviews配列を返します。どちらも「表示するものがない」として扱い、「データなし」というラベルを表示したい場合は、空の配列を合計すると0になるため、length == 0をチェックしてください。
発生するエラー
リファレンスページには、分析に関するリソース固有のエラーコードは記載されていません。発生するケースは次のとおりです。
全一覧はエラーコードにあります。