versión API Graph

Métricas de insights de un artículo instantáneo

Este objeto representa el conjunto de métricas de insights de un único artículo instantáneo según su URL canónica. Las métricas de artículo se pueden consultar, así como las métricas de activos multimedia individuales del artículo.

Para obtener más información sobre los artículos instantáneos, lee nuestra documentación para desarrolladores sobre artículos instantáneos.

Insights de artículos

El extremo que se usa para consultar insights de artículo se determina según la URL canónica del artículo que se consulta y la métrica que se busca. A continuación se indican todas las métricas disponibles.

Explorador de la API Graph

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

Permisos

Un identificador de acceso a la página con el permisoread_insights puede recuperar métricas de dicha página. Para obtener más información sobre los identificadores de acceso a la página, consulta nuestra documentación Identificadores de acceso a la página.

Parámetros

Nombre	Descripción	Tipo	Obligatorio
`id`	URL canónica del artículo instantáneo.	`url`	`yes`
`metric`	Métrica que se solicita.	Consulta las métricas disponibles a continuación.	`yes`
`period`	Periodo de tiempo durante el que se agrega la métrica.	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	Límite inferior del intervalo de tiempo que se debe tener en cuenta. Valor predeterminado: `2 weeks ago`	`datetime`	`no`
`until`	Límite superior del intervalo de tiempo que se debe tener en cuenta. Valor predeterminado: `Current time`	`datetime`	`no`
`breakdown`	Resultados independientes según la plataforma (iOS o Android) en la que se produjo la métrica. Si no se especifica, los resultados incluyen ambas plataformas.	`enum{platform}`	`no`

Campos

Una lectura desde este perímetro devolverá un resultado en formato JSON:

{
  "data": []
}

data

Lista de objetos InsightsQueryResult. Se añadirán los siguientes campos a cada objeto que se devuelve:

Nombre Descripción Tipo

Nombre	Descripción	Tipo
time	Inicio del periodo u hora de finalización del periodo total.	`datetime`
value	Recuento, media, proporción o porcentaje de la métrica en el periodo.	`numeric`
breakdowns	Depósito al que pertenece el valor (p. ej., cuando se usa la métrica `all_view_durations` o si el parámetro `breakdown(platform)` se especifica de forma explícita).	`map<string, string>`

time

Inicio del periodo u hora de finalización del periodo total.

datetime

value

Recuento, media, proporción o porcentaje de la métrica en el periodo.

numeric

breakdowns

Depósito al que pertenece el valor (p. ej., cuando se usa la métrica

all_view_durations

o si el parámetro

breakdown(platform)

se especifica de forma explícita).

map<string, string>

Métricas disponibles

A continuación se indican los periodos de agregación disponibles para las distintas métricas. Las métricas se recopilan de dispositivos iOS y Android.

Nombre	Descripción	Valor del periodo
`all_views`	Número de visualizaciones.	`day`
`all_view_durations`	Duración de la visualización con desgloses.	`week`
`all_view_durations_average`	Duración media de la visualización.	`week`
`all_scrolls`	Profundidad de desplazamiento con desgloses.	`week`
`all_scrolls_average`	Profundidad de desplazamiento media.	`week`

Ejemplos

Visualizaciones de artículos diarias durante los últimos siete días

Para consultar los desgloses diarios del número de visualizaciones de uno de tus artículos instantáneos durante los últimos siete días, emite la siguiente solicitud 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

Esta solicitud devolverá la siguiente respuesta:

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

Visualizaciones de artículos diarias durante los últimos siete días con desglose de plataforma

Para consultar los desgloses diarios del número de visualizaciones de uno de tus artículos instantáneos durante los últimos siete días desglosados según la plataforma en la que se vio, emite la siguiente solicitud 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

Esta solicitud devolverá la siguiente respuesta:

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

Duraciones de las visualizaciones de artículos semanales durante los últimos siete días

Para consultar los desgloses semanales de las duraciones de las visualizaciones en depósitos de uno de tus artículos instantáneos durante los últimos siete días, emite la siguiente solicitud 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

Esta solicitud devolverá la siguiente respuesta. Ten en cuenta que los datos que se devuelven en esta respuesta están en depósitos:

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