Версия API Graph

Статистические метрики для моментальной статьи

Этот объект представляет набор статистических метрик для одной моментальной статьи на основе ее канонического URL. Вы можете запрашивать метрики на уровне статьи, а также метрики отдельных медиаобъектов в статье.

Дополнительные сведения о моментальных статьях см. в нашей документации по моментальным статьям для разработчиков.

Статистика по статьям

Конечная точка для запроса статистики на уровне статьи определяется каноническим URL соответствующей статьи и интересующей вас метрики. Ниже перечислены все доступные метрики.

Graph API Explorer

GET /v21.0/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/?fields=instant_article{insights.metric(metric-name)}&id={canonical-url}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Разрешения

Для получения метрики для Страницы необходим маркер доступа к этой Странице с разрешениемread_insights. Подробную информацию о маркерах доступа к Страницам см. в соответствующей документации.

Параметры

Имя	Описание	Тип	Обязательный
`id`	Канонический URL моментальной статьи.	`url`	`yes`
`metric`	Запрашиваемая метрика.	См. список доступных метрик ниже.	`yes`
`period`	Период обобщения метрики.	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	Нижняя граница рассматриваемого временного диапазона. Значение по умолчанию — `2 weeks ago`	`datetime`	`no`
`until`	Верхняя граница рассматриваемого временного диапазона. Значение по умолчанию — `Current time`.	`datetime`	`no`
`breakdown`	Разделение результатов по платформам (iOS и Android), к которым относится метрика. Если этот параметр не указан, результаты выдаются для обеих платформ.	`enum{platform}`	`no`

Поля

При считывании этой границы контекста результат будет представлен в формате JSON:

{
  "data": []
}

data

Список объектов InsightsQueryResult. В каждый возвращаемый объект добавляются следующие поля:

Имя Описание Тип

Имя	Описание	Тип
time	Время начала или окончания срока действия.	`datetime`
value	Количество, среднее значение, соотношение или процентное значение метрики за период.	`numeric`
breakdowns	Категория, к которой принадлежит значение (например, когда используется метрика `all_view_durations` или если параметр `breakdown(platform)` указан явным образом).	`map<string, string>`

time

Время начала или окончания срока действия.

datetime

value

Количество, среднее значение, соотношение или процентное значение метрики за период.

numeric

breakdowns

Категория, к которой принадлежит значение (например, когда используется метрика

all_view_durations

или если параметр

breakdown(platform)

указан явным образом).

map<string, string>

Доступные метрики

Ниже представлены периоды обобщения для разных метрик. Метрики собираются с устройств iOS и Android.

Имя	Описание	Значение за период
`all_views`	Количество просмотров	`day`
`all_view_durations`	Длительность просмотра с разбивками	`week`
`all_view_durations_average`	Средняя длительность просмотра	`week`
`all_scrolls`	Глубина прокрутки с разбивками	`week`
`all_scrolls_average`	Средняя глубина прокрутки	`week`

Примеры

Ежедневные просмотры статьи за последние 7 дней.

Чтобы получить ежедневные разбивки количества просмотров одной из моментальных статей за последние 7 дней, отправьте следующий запрос GET:

GET /v21.0/?fields=instant_article{insights.metric(all_views).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

Ответ будет выглядеть так:

{
   "instant_article": {
      "insights": {
         "data": [
            {
               "time": "2015-10-28T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-30T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-10-31T08:00:00+0000",
               "value": "3"
            },
            {
               "time": "2015-11-01T08:00:00+0000",
               "value": "2"
            },
            {
               "time": "2015-11-02T08:00:00+0000",
               "value": "6"
            },
            {
               "time": "2015-11-03T08:00:00+0000",
               "value": "4"
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}

Ежедневные просмотры статей за последние 7 дней с разбивкой по платформам

Чтобы получить ежедневные разбивки количества просмотров одной из моментальных статей за последние 7 дней с дальнейшей разбивкой по платформам, на которых они просматривались, отправьте следующий запрос GET:

GET /v21.0/?fields=instant_article{insights.metric(all_views).breakdown(platform).period(day).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

Ответ будет выглядеть так:

{
   "instant_article": {
      "insights": {
         "data": [
            {
              "time": "2015-10-28T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-28T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            },
            {
              "time": "2015-10-29T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-29T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            },
            {
              "time": "2015-10-30T08:00:00+0000",
              "value": "1",
              "breakdowns": {
                "platform": "ANDROID"
              }
            },
            {
              "time": "2015-10-30T08:00:00+0000",
              "value": "2",
              "breakdowns": {
                "platform": "IOS"
              }
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}

Длительность просмотра статей за неделю за последние 7 дней

Чтобы получить еженедельные разбивки длительности просмотров одной из моментальных статей с разделением по категориям за последние 7 дней, отправьте следующий запрос GET:

GET /v21.0/?fields=instant_article{insights.metric(all_view_durations).period(week).since(7 day ago).until(now)}&id=http://www.example.com/my-test-page.html&access_token={your-page-access-token} HTTP/1.1
Host: graph.facebook.com

Ответ будет выглядеть так: Обратите внимание: данные, полученные в этом ответе, категоризованы:

{
   "instant_article": {
      "insights": {
         "data": [
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "8",
               "breakdowns": {
                  "bucket": "15"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "2",
               "breakdowns": {
                  "bucket": "225"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "2",
               "breakdowns": {
                  "bucket": "90"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "360"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "240"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "165"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "120"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "75"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "60"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "45"
               }
            },
            {
               "time": "2015-10-29T08:00:00+0000",
               "value": "1",
               "breakdowns": {
                  "bucket": "30"
               }
            }
         ]
      },
      "id": "<article-id>"
   },
   "id": "http://www.example.com/my-test-page.com"
}