IGメディアインサイト

IGメディアオブジェクトについてのソーシャルインタラクション指標を表します。

作成

この操作はサポートされていません。

読み取り

GET /{ig-media-id}/insights

IGメディアオブジェクトについてのインサイトデータを取得します。

制限

• インサイトデータは、アルバムIGメディア内のどのメディアにも使用できません。
• ストーリーズがアーカイブまたはハイライトされている場合であっても、ストーリーズメディア指標は24時間しか使用できません。有効期限が切れる前にストーリーズの最新のインサイトを取得するには、Instagramトピック用のWebhookを設定し、story_insightsフィールドをサブスクリプション登録します。
• 値が5未満のストーリーズメディア指標は、(#10) Not enough viewers for the media to show insightsというメッセージとともにエラーコード10を返します。
• ヨーロッパと日本のユーザーが作成したストーリーズについては、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}

パスパラメーター

クエリ文字列パラメーター

内訳

1つ以上の内訳を指定することもできます。その場合の結果は、指定された内訳に基づいて、より細かいセットに分割されます。値は次のいずれかです。

• action_type — profile_activity指標とのみ互換性があります。アプリユーザーのプロフィールを表示した後で閲覧者がタップまたはクリックしたプロフィールUIコンポーネントごとに分割した結果。応答値は次のいずれかです。

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

アップデート

この操作はサポートされていません。

削除

この操作はサポートされていません。