IG 影音素材洞察報告

代表 IG 影音素材物件的社群互動衡量指標。

建立

不支援執行此作業。

讀取

GET /{ig-media-id}/insights

取得 IG 影音素材物件的洞察報告資料。

限制

• 相簿 IG 影音素材內的任何影音素材均沒有洞察報告資料。
• 系統只會提供 24 小時內的限時動態影音素材衡量指標，即使該則限時動態設為封存或精選也一樣。如果您要在限時動態過期之前取得最新的洞察報告，請為 Instagram 主題設定 Webhook 並訂閱 story_insights 欄位。
• 衡量指標值少於 5 個的限時動態影音素材衡量指標會傳回錯誤代碼 10，其訊息內文為：(#10) Not enough viewers for the media to show insights。
• 若是歐洲和日本用戶所建立的限時動態，replies 衡量指標現在會傳回 0 值。
• 若是限時動態，replies 計算中不會包括歐洲和日本用戶的回覆次數。
• 如果您要求的洞察報告資料不存在或目前無法使用，API 會傳回空白資料集，而不是用於個別衡量指標的 0。
• 用於計算衡量指標的資料最多可能延遲 48 小時。

需求

要求語法

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

路徑參數

查詢字串參數

衡量指標

相簿衡量指標

相片和影片衡量指標

不支援相簿中的影音素材衡量指標，但可以取得相簿的衡量指標。

連續短片衡量指標

限時動態衡量指標

要求範例

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}

路徑參數

查詢字串參數

資料解析

您也可以指定一或多個資料解析，並根據指定的資料解析將結果細分為較小的集合。可能的值如下：

• 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.」），因此，如果在單一查詢中要求多個衡量指標，請務必小心。

衡量指標

貼文衡量指標

下列衡量指標可用於以貼文形式發佈的圖像和影片 IG 影音素材。不支援相簿輪播和 IGTV 廣告。

限時動態衡量指標

下列衡量指標可用於以限時動態發佈的 IG 影音素材。

回應

包含查詢結果的 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}"
    }
  ]
}

回應內容

貼文衡量指標要求範例

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"
    }
  ]
}

更新

不支援執行此作業。

刪除

不支援執行此作業。