Version API du graphe

Indicateurs des insights pour les Instant Articles

Cet objet représente l’ensemble d’indicateurs d’insights d’un Instant Article, en fonction de son URL réglementaire. Vous pouvez exécuter des requêtes portant sur des indicateurs au niveau de l’article, mais aussi sur des indicateurs d’éléments multimédias particuliers de l’article.

Pour plus d’informations sur la fonctionnalité Instant Articles, consultez notre documentation développeur·se concernant les Instant Articles.

Insights des articles

Le point de terminaison utilisé pour obtenir des insights au niveau de l’article est déterminé par l’URL réglementaire de l’article qui fait l’objet de la requête et par l’indicateur recherché. Tous les indicateurs disponibles sont répertoriés ci-après.

Explorateur de l’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
}];

Autorisations

Un token d’accès de Page doté de l’autorisationread_insights peut récupérer les indicateurs concernant cette Page. Pour plus d’informations sur les tokens d’accès de Page, consultez notre documentation relative aux tokens d’accès de Page.

Paramètres

Nom	Description	Type	Obligatoire
`id`	URL réglementaire de l’Instant Article.	`url`	`yes`
`metric`	Indicateur demandé.	Reportez-vous à Indicateurs disponibles ci-après.	`yes`
`period`	Période pendant laquelle l’indicateur est agrégé.	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	Limite inférieure de la période à prendre en compte. Valeur par défaut : `2 weeks ago`	`datetime`	`no`
`until`	Limite supérieure de la période à prendre en compte. Valeur par défaut : `Current time`	`datetime`	`no`
`breakdown`	Répartition des résultats en fonction de la plateforme (iOS ou Android) sur laquelle l’indicateur a été généré. Si ce paramètre n’est pas spécifié, les résultats portent sur les deux plateformes.	`enum{platform}`	`no`

Champs

La lecture à partir de cette arête renverra un résultat au format JSON :

{
  "data": []
}

data

Liste des objets InsightsQueryResult. Les champs suivants seront ajoutés à chaque objet renvoyé :

Nom Description Type

Nom	Description	Type
time	Début de la période, ou heure de fin de la période globale.	`datetime`
value	Décompte, moyenne, ratio ou pourcentage de l’indicateur dans la période.	`numeric`
breakdowns	Ensemble auquel appartient la valeur (par exemple, lorsque l’indicateur `all_view_durations` est utilisé ou que le paramètre `breakdown(platform)` est spécifié explicitement).	`map<string, string>`

time

Début de la période, ou heure de fin de la période globale.

datetime

value

Décompte, moyenne, ratio ou pourcentage de l’indicateur dans la période.

numeric

breakdowns

Ensemble auquel appartient la valeur (par exemple, lorsque l’indicateur

all_view_durations

est utilisé ou que le paramètre

breakdown(platform)

est spécifié explicitement).

map<string, string>

Indicateurs disponibles

Le tableau ci-après présente les périodes d’agrégation disponibles pour les différents indicateurs. Les indicateurs sont collectés à partir des appareils iOS et Android.

Nom	Description	Valeur de période
`all_views`	Nombre de vues.	`day`
`all_view_durations`	Durée de la vue avec répartitions.	`week`
`all_view_durations_average`	Durée moyenne des vues.	`week`
`all_scrolls`	Profondeur de défilement avec répartitions.	`week`
`all_scrolls_average`	Profondeur de défilement moyenne.	`week`

Exemples

Vues quotidiennes des articles sur les 7 derniers jours

Pour demander les répartitions quotidiennes du nombre de vues de l’un de vos Instant Articles au cours des 7 derniers jours, exécutez la requête GET suivante :

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

Cette requête renverra la réponse suivante :

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

Vues quotidiennes des articles sur les 7 derniers jours avec répartition par plateforme

Pour demander les répartitions quotidiennes du nombre de vues de l’un de vos Instant Articles au cours des 7 derniers jours, ainsi que la répartition par plateforme de consultation, exécutez la requête GET suivante :

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

Cette requête renverra la réponse suivante :

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

Durées de lecture des vues hebdomadaires des articles sur les 7 derniers jours

Pour demander les répartitions hebdomadaires des durées de lecture décomposées des vues de l’un de vos Instant Articles au cours des 7 derniers jours, exécutez la requête GET suivante :

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

Cette requête renverra la réponse suivante. Notez que les données renvoyées dans cette réponse sont décomposées :

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