Статистика объекта IG Media

Представляет метрики социального взаимодействия для объекта IG Media.

Создание

Эта операция не поддерживается.

Чтение

GET /{ig-media-id}/insights

Позволяет получить статистику для объекта IG Media.

Ограничения

• Статистика недоступна ни для каких медиафайлов в альбомах объекта IG Media.
• Статистика по медиафайлам историй доступна только за 24 часа, даже если истории помещены в архив или в избранное. Чтобы получать самую актуальную статистику истории до окончания срока ее существования, настройте Webhooks для темы Instagram и подпишитесь на поле story_insights.
• Для метрик медиафайлов историй со значениями меньше 5 возвращается ошибка с кодом 10 и сообщением (#10) Not enough viewers for the media to show insights.
• Метрика replies для историй, созданных пользователями из Европы и Японии, теперь возвращает значение 0.
• Ответы на истории пользователей из Европы и Японии не учитываются в расчетах метрики replies.
• Если запрашиваемые данные статистики на текущий момент не существуют или недоступны, вместо значений 0 для отдельных метрик API возвращает пустой набор данных.
• Данные, используемые для вычисления метрик, могут поступать с задержкой до 48 часов.

Требования

Синтаксис запроса

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

Параметры пути

Параметры строки запроса

Метрики

Метрики для альбома

Метрики для фото и видео

Метрики для медиафайлов, находящихся в альбомах, не поддерживаются. Вместо этого необходимо получить метрики для соответствующего альбома.

Метрики видео Reels

Метрики историй

Пример запроса

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 Media, размещенных в виде публикации. Альбомы в формате кольцевой галереи и IGTV не поддерживаются.

Метрики историй

Следующие метрики доступны для IG Media, размещенных в виде истории.

Ответ

Объект 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"
    }
  ]
}

Обновление

Эта операция не поддерживается.

Удаление

Эта операция не поддерживается.