Versão Graph API

Métricas de insights sobre Instant Articles

Este objeto representa o conjunto de métricas de insights sobre um Instant Article com base na URL canônica do artigo. É possível consultar métricas no nível do Instant Article, bem como métricas sobre ativos de mídia individuais que estão presentes no artigo.

Para saber mais, leia a documentação para desenvolvedores sobre Instant Articles.

Insights sobre o artigo

O ponto de extremidade usado para consultar insights no nível do Instant Article é determinado pela URL canônica do artigo consultado e pela métrica pesquisada. Veja todas as métricas disponíveis listadas abaixo.

Explorador da Graph API

GET /v19.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
}];

Permissões

Um token de acesso à Página com a permissão read_insights pode exibir métricas da Página em questão. Para obter mais informações, consulte a documentação sobre tokens de acesso à Página.

Parâmetros

Nome	Descrição	Tipo	Obrigatório
`id`	A URL canônica do Instant Article.	`url`	`yes`
`metric`	A métrica solicitada.	Consulte as métricas disponíveis abaixo.	`yes`
`period`	O período referente à agregação da métrica.	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	O limite inferior do intervalo de tempo a ser considerado. Valor-padrão: `2 weeks ago`	`datetime`	`no`
`until`	O limite superior do intervalo de tempo a ser considerado. Valor-padrão: `Current time`	`datetime`	`no`
`breakdown`	Separe os resultados de acordo com a plataforma (iOS ou Android) em que a métrica ocorreu. Se esse valor não for especificado, os resultados incluirão ambas as plataformas.	`enum{platform}`	`no`

Campos

A leitura a partir dessa borda retornará um resultado no formato JSON:

{
  "data": []
}

data

Uma lista de objetos InsightsQueryResult. Os seguintes campos serão adicionados a cada objeto retornado:

Nome Descrição Tipo

Nome	Descrição	Tipo
time	O início do período ou a hora de término do período total.	`datetime`
value	A contagem, média, proporção ou porcentagem da métrica no período.	`numeric`
breakdowns	O grupo ao qual o valor pertence (ou seja, quando a métrica `all_view_durations` é usada ou se o parâmetro `breakdown(platform)` for especificado explicitamente).	`map<string, string>`

time

O início do período ou a hora de término do período total.

datetime

value

A contagem, média, proporção ou porcentagem da métrica no período.

numeric

breakdowns

O grupo ao qual o valor pertence (ou seja, quando a métrica

all_view_durations

é usada ou se o parâmetro

breakdown(platform)

for especificado explicitamente).

map<string, string>

Métricas disponíveis

Veja abaixo os períodos de agregação disponíveis para diferentes métricas. As métricas são coletadas em dispositivos iOS e Android.

Nome	Descrição	Valor de período
`all_views`	Número de visualizações	`day`
`all_view_durations`	Duração das visualizações com detalhamentos	`week`
`all_view_durations_average`	Duração média das visualizações	`week`
`all_scrolls`	Profundidade de rolagem com detalhamentos	`week`
`all_scrolls_average`	Profundidade média de rolagem	`week`

Exemplos

Visualizações diárias do artigo nos últimos 7 dias

Para consultar detalhamentos diários do número de visualizações de um dos seus Instant Articles nos últimos 7 dias, faça a solicitação GET a seguir:

GET /v19.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

Essa solicitação retornará a seguinte resposta:

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

Visualizações diárias do artigo nos últimos 7 dias com detalhamentos da plataforma

Para consultar detalhamentos diários do número de visualizações de um dos seus Instant Articles nos últimos 7 dias (e também especificar a plataforma em que o artigo foi visualizado), faça a solicitação GET a seguir:

GET /v19.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

Essa solicitação retornará a seguinte resposta:

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

Durações de visualizações semanais do artigo nos últimos 7 dias

Para consultar detalhamentos semanais das durações de visualizações agrupadas de um dos seus Instant Articles nos últimos 7 dias, faça a solicitação GET a seguir:

GET /v19.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

Essa solicitação retornará a resposta a seguir. Vale ressaltar que os dados retornados estão agrupados:

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