Instagram 媒體洞察報告

代表 Instagram 媒體物件上的社交互動衡量數據。

建立

不支援這項操作。

讀取

GET /{ig-media-id}/insights

獲取 Instagram 媒體物件的洞察報告資料。

限制

  • 洞察報告資料不適用於 Instagram 媒體相簿中的任何媒體。
  • 即使限時動態已獲典藏或設為精選,限時動態媒體的衡量數據也只在 24 小時內有效。如果您希望在限時動態過期之前獲得最新洞察報告,請為 Instagram 主題設定 Webhooks,並訂閱 story_insights 欄位。
  • 限時動態媒體衡量數據的數值若小於 5,系統將傳回錯誤代碼 10,並顯示訊息 (#10) Not enough viewers for the media to show insights
  • 對於歐洲和日本用戶所製作的限時動態,replies 衡量數據目前將傳回數值 0
  • 對於限時動態,歐洲和日本用戶作出的回覆將不會包含在 replies 計算中。
  • 如果您正在要求的洞察報告資料不存在或者目前無法提供,API 將為個別衡量數據傳回空資料集,而不是傳回 0
  • 用於計算衡量數據的數據最多可延遲 48 小時。

必要條件

類型說明

存取憑證

用戶

權限

instagram_basic
instagram_manage_insights
pages_read_engagement
pages_show_list


如果應用程式用戶透過企業管理平台取得專頁角色,您還將需要以下其中一項:


ads_management
business_management

要求語法

GET https://graph.facebook.com/{api-version}/{ig-media-id}/insights
  ?metric={metric}
  &access_token={access-token}

路徑參數

預留位置

{api-version}

API 版本

{ig-media-id}

此為必要項目。Instagram 媒體編號。

查詢字串參數

參數

{access-token}

類型:字串

此為必要項目。應用程式用戶的用戶存取憑證

{metric}

類型:以逗號分隔的清單

此為必要項目。您想系統傳回的衡量數據逗號分隔清單。

衡量數據

部分衡量數據已在 v18.0 中停用。由 2023 年 12 月 11 日起,所有版本都將停用這些衡量數據。請使用列出的替代衡量數據。

total_interactions 被列為部分已停用衡量數據的替代數據,目前僅在版本 18.0 中可用,不適用於舊版本。查詢 2023 年 12 月 11 日前的舊版本時,請使用 engagement 衡量數據。

詳情請參閱變更記錄

相簿衡量數據

衡量數據說明

carousel_album_engagement
v18.0 以上版本均已停用

相簿 Instagram 媒體物件的讚好總數和 Instagram 留言總數。
替代衡量數據:total_interactions

carousel_album_impressions
v18.0 以上版本均已停用

相簿 Instagram 媒體物件的總查看次數。
替代衡量數據:impressions

carousel_album_reach
v18.0 以上版本均已停用

查看過相簿 Instagram 媒體物件的不重複 Instagram 帳戶總數。
替代衡量數據:reach

carousel_album_saved
v18.0 以上版本均已停用

儲存過相簿 Instagram 媒體物件的不重複 Instagram 帳戶總數。
替代衡量數據:saved

carousel_album_video_views
v18.0 以上版本均已停用

查看過相簿中影片 Instagram 媒體的不重複 Instagram 帳戶總數。
替代衡量數據:video_views

相片和影片衡量數據

不支援為相簿中的媒體提供衡量數據,請改為選擇相簿衡量數據。

衡量數據說明

engagement
v18.0 以上版本均已停用

Instagram 媒體likes_countcomment_countsaved 之總和。
替代衡量數據:total_interactions
備註:您可能會看到不同的結果。engagement 包含讚好、留言和儲存次數,而 total_interactions 則包含讚好、留言、儲存和分享次數。

impressions

Instagram 媒體物件的總查看次數。

reach

查看過 Instagram 媒體物件的不重複 Instagram 帳戶總數。

saved

儲存過 Instagram 媒體物件的不重複 Instagram 帳戶總數。

video_views

影片 Instagram 媒體的總查看次數。相簿 Instagram 媒體則為所有影片的總查看次數。

Reels 連續短片衡量數據

衡量數據說明

clips_replays_count

連續短片在初次播放後開始重播的次數;其定義為在同一個連續短片連線階段中,重播 1 毫秒或以上的次數。

comments

連續短片獲得的回應數量。調整中的衡量數據。

ig_reels_aggregated_all_plays_count

在已計算 1 次展示後,您連續短片開始播放或重新播放的次數;其定義為播放 1 毫秒或以上的次數。在同一個連續短片連線階段中初次播放內容後,後續的播放動作將會計為重新播放。

ig_reels_avg_watch_time

連續短片的平均播放時長。調整中的衡量數據。

ig_reels_video_view_total_time

連續短片的總播放時長,包括重播連續短片的時間。調整中的衡量數據。

likes

連續短片獲得的讚好數量。調整中的衡量數據。

plays

連續短片在開始計算展示次數後所獲得的播放次數。一次播放是指播放影片最少 1 毫秒,重播不計算在內。調整中的衡量數據。

reach

觀看過連續短片最少一次的不重複帳戶數量。接觸人數與展示次數不同,後者可能包含同一個帳戶多次看到連續短片的統計數字。此衡量數據為估計值,且仍在調整中

saved

用戶儲存連續短片的次數。調整中的衡量數據。

shares

用戶分享連續短片的次數。調整中的衡量數據。

total_interactions

連續短片獲得的讚好數量、儲存次數、回應數量和分享次數,再減去取消讚好的數量、取消儲存的次數以及被刪除的回應數量。調整中的衡量數據。

限時動態衡量數據

衡量數據說明

exits
v18.0 以上版本均已停用

用戶退出限時動態 Instagram 媒體物件的總次數。
替代衡量數據:navigation
資料細節:story_navigation_action_type

impressions

限時動態 Instagram 媒體物件的總查看次數。

reach

查看過限時動態 Instagram 媒體物件的不重複 Instagram 帳戶總數。

replies

限時動態 Instagram 媒體物件的回覆次數(Instagram 留言)總數。此值不包括某些地區用戶的回覆。這些地區包括:歐洲(從 2020 年 12 月 1 日開始)和日本(從 2021 年 4 月 14 日開始)。如果限時動態是由這些地區之一的用戶所建立,則會傳回值 0

taps_forward
v18.0 以上版本均已停用

用戶點按查看此限時動態 Instagram 媒體物件的下一張相片或下一段影片的總次數。
替代衡量數據:navigation
資料細節:story_navigation_action_type

taps_back
v18.0 以上版本均已停用

用戶點按查看此限時動態 Instagram 媒體物件的上一張相片或上一段影片的總次數。
替代衡量數據:navigation
資料細節:story_navigation_action_type

要求範例

curl -X GET \
  'https://graph.facebook.com/v19.0/17895695668004550/insights?metric=impressions,reach&access_token=IGQVJ...'

回應範例

{
  "data": [
    {
      "name": "impressions",
      "period": "lifetime",
      "values": [
        {
          "value": 264
        }
      ],
      "title": "Impressions",
      "description": "Total number of times the media object has been seen",
      "id": "17855590849148465/insights/impressions/lifetime"
    },
    {
      "name": "reach",
      "period": "lifetime",
      "values": [
        {
          "value": 103
        }
      ],
      "title": "Reach",
      "description": "Total number of unique accounts that have seen the media object",
      "id": "17855590849148465/insights/reach/lifetime"
    }
  ]
}

全新衡量數據

下方所列的全新衡量數據將逐步開放予所有開發人員使用。這些衡量數據將最終取代上方列出的舊有衡量數據。如您看到此訊息,便可使用下方所述的全新衡量數據。

要求語法

GET https://graph.facebook.com/{api-version}/{ig-media-id}/insights
  ?metric={metric}
  &breakdown={breakdown}
  &access_token={access-token}

路徑參數

預留位置

{api-version}

API 版本

{ig-media-id}

此為必要項目。Instagram 媒體編號。

查詢字串參數

鍵值 預留位置

access_token

{access-token}

此為必要項目。應用程式用戶的用戶存取憑證。

breakdown

{breakdown}

指定如何將結果組合細分為子集。請參閱資料細節

metric

{metric}

此為必要項目。您想系統傳回的衡量數據逗號分隔清單。

資料細節

您也可以指定一項或多項資料細節,結果將根據指定的資料細節相應地細分為更小的組合。值可以是:

  • action_type:僅與 profile_activity 衡量數據相容。按照觀眾在查看應用程式用戶的個人檔案後所點按或點擊的個人檔案用戶介面元件來細分結果。回應值為:
    • BIO_LINK_CLICKED
    • CALL
    • DIRECTION
    • EMAIL
    • OTHER
    • TEXT
  • story_navigation_action_type:按照觀眾在查看媒體時採取的導覽動作來細分結果。
    • TAP_BACK
    • TAP_EXIT
    • TAP_FORWARD
    • SWIPE_FORWARD

請參閱衡量數據表,以確定哪些衡量數據支援資料細節,及其支援哪些資料細節。如果您要求取得不支援資料細節的衡量數據,API 將傳回一個錯誤(「An unknown error has occurred.」),因此如果在單個查詢中索取多項衡量數據,請加倍小心。

衡量數據

帖子衡量數據

以下衡量數據適用於作為帖子發佈的圖片和影片類 Instagram 媒體。相簿輪播廣告和 IGTV 不受支援。

衡量數據資料細節說明

comments

不適用

您帖子收到的回應數量。

follows

不適用

開始追蹤您的帳戶數量。

likes

不適用

您帖子收到的讚好次數。

profile_activity

action_type

用戶在與您的帖子互動後,瀏覽您的個人檔案時採取的動作數量。

profile_visits

不適用

用戶瀏覽您個人檔案的次數。

shares

不適用

您帖子獲分享的次數。

total_interactions

不適用

您帖子獲得的讚好數量、儲存次數、回應數量和分享次數,再減去取消讚好的數量、取消儲存的次數以及被刪除的留言數量。

限時動態衡量數據

以下衡量數據適用於作為限時動態發佈的 Instagram 媒體。

衡量數據 資料細節 說明

follows

不適用

這是開始追蹤您的帳戶數量。

navigation

story_navigation_action_type

這是用戶因為您的限時動態而採取的動作總數。相關衡量數據包括離開、轉寄、返回和下一個限時動態等。

profile_activity

action_type

用戶在與您的限時動態互動後,瀏覽您的個人檔案時採取的動作次數。

profile_visits

不適用

用戶瀏覽您個人檔案的次數。

shares

不適用

您限時動態獲分享的次數。

total_interactions

不適用

您限時動態獲回覆和分享的次數。

回應

包含查詢結果的 JSON 物件。視乎您的查詢規格,結果可以包含下列資料:

{
  "data": [
    {
      "name": "{name}",
      "period": "{period}",
      "values": [
        {
          "value": {value}
        }
      ],
      "title": "{title}",
      "description": "{description}",
      "total_value": {
        "value":{value},
        "breakdowns": [
          {
            "dimension_keys": [
              "{dimension-key-1}",
              "{dimension-key-2}"
              ...
            ],
            "results": [
              {
                "dimension_values": [
                  "dimension-value-1",
                  "dimension-value-2"
                  ...
                ],
                "value": {value}
              },
              ...
            ]
          }
        ]
      },
      "id": "{id}"
    }
  ]
}

回應內容

屬性 值類型 說明

data

陣列

包含描述要求結果的物件之陣列。

name

字串

衡量數據名稱。

period

字串

要求的時限。系統會自動將要求時限設為 lifetime,並且無法更改。因此,此值一律為 lifetime

values

陣列

描述所要求衡量數據值的物件之陣列。

value

整數

若是 data.values.value,則為要求的衡量數據值之總和。


若是 data.total_value.value,則為要求的資料細節值之總和。


若是 data.total_value.breakdowns.results.value,則為資料細節組合值之總和。

title

字串

衡量數據標題。

description

字串

衡量數據說明。

id

字串

說明查詢路徑參數的字串。

total_value

物件

描述所要求資料細節值的物件(如有要求提供資料細節)。

breakdowns

陣列

描述所要求資料細節及其結果的物件之陣列。

dimension_keys

陣列

描述所要求資料細節的字串之陣列。

results

陣列

描述每個資料細節組合的物件之陣列。

dimension_values

字串

描述資料細節組合值的字串之陣列。值可對應到 dimension_keys

paging

物件

包含用於索取下一個結果組合的網址之物件。詳情請參閱分頁結果

previous

字串

用於擷取上一頁結果的網址。詳情請參閱分頁結果

next

字串

用於擷取下一頁結果的網址。詳情請參閱分頁結果

帖子衡量數據要求範例

curl -i -X GET \
 "https://graph.facebook.com/v19.0/17932174733377207/insights?metric=profile_activity&breakdown=action_type&access_token=EAAOc..."

帖子衡量數據回應範例

{
  "data": [
    {
      "name": "profile_activity",
      "period": "lifetime",
      "values": [
        {
          "value": 4
        }
      ],
      "title": "Profile activity",
      "description": "[IG Insights] This header is the name of a metric that appears on an educational info sheet for a particular post, story, video or promotion. This metric is the sum of all profile actions people take when they engage with this content.",
      "total_value": {
        "value": 4,
        "breakdowns": [
          {
            "dimension_keys": [
              "action_type"
            ],
            "results": [
              {
                "dimension_values": [
                  "email"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "text"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "direction"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "bio_link_clicked"
                ],
                "value": 1
              }
            ]
          }
        ]
      },
      "id": "17932174733377207/insights/profile_activity/lifetime"
    }
  ]
}

限時動態衡量數據要求範例

curl -i -X GET \
 "https://graph.facebook.com/v19.0/17969782069736348/insights?metric=navigation&breakdown=story_navigation_action_type&access_token=EAAOc..."

限時動態衡量數據回應範例

{
  "data": [
    {
      "name": "navigation",
      "period": "lifetime",
      "values": [
        {
          "value": 25
        }
      ],
      "title": "Navigation",
      "description": "This is the total number of actions taken from your story. These are made up of metrics like exited, forward, back and next story.",
      "total_value": {
        "value": 25,
        "breakdowns": [
          {
            "dimension_keys": [
              "story_navigation_action_type"
            ],
            "results": [
              {
                "dimension_values": [
                  "tap_forward"
                ],
                "value": 19
              },
              {
                "dimension_values": [
                  "tap_back"
                ],
                "value": 4
              },
              {
                "dimension_values": [
                  "tap_exit"
                ],
                "value": 1
              },
              {
                "dimension_values": [
                  "swipe_forward"
                ],
                "value": 1
              }
            ]
          }
        ]
      },
      "id": "17969782069736348/insights/navigation/lifetime"
    }
  ]
}

更新

不支援這項操作。

刪除

不支援這項操作。