Versi Graph API

Metrik Insight untuk Artikel Instan

Objek ini mewakili set metrik insight untuk satu Artikel Instan, berdasarkan URL kanonisnya. Metrik level artikel dapat di-kueri, serta metrik pada aset media individu dalam artikel.

Untuk informasi selengkapnya tentang Artikel Instan, baca Dokumentasi Developer Artikel Instan.

Insight Artikel

Endpoint yang digunakan untuk meng-kueri insight level artikel ditentukan oleh URL kanonis dari artikel yang di-kueri dan metrik yang sedang dicari. Semua metrik yang tersedia tercantum di bawah ini.

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

Izin

Token akses halaman dengan izin read_insights dapat mengambil metrik untuk Halaman tersebut. Untuk informasi selengkapnya tentang token akses halaman, buka dokumentasi Token Akses Halaman kami.

Parameter

Nama	Deskripsi	Jenis	Wajib
`id`	URL Kanonis dari Artikel Instan.	`url`	`yes`
`metric`	Metrik yang diminta.	Lihat metrik yang tersedia di bawah ini	`yes`
`period`	Periode waktu saat metrik dikumpulkan.	`enum{day, week, days_28, month, lifetime}`	`yes`
`since`	Batas bawah rentang waktu yang perlu dipertimbangkan. Nilai default: `2 weeks ago`	`datetime`	`no`
`until`	Batas atas rentang waktu yang perlu dipertimbangkan. Nilai default: `Current time`	`datetime`	`no`
`breakdown`	Pisahkan hasil berdasarkan metrik terjadi di platform mana (iOS atau Android). Jika tidak ditentukan, hasilnya mencakup kedua platform.	`enum{platform}`	`no`

Kolom

Membaca dari edge ini akan memberikan hasil berformat JSON:

{
  "data": []
}

data

Daftar objek InsightsQueryResult. Kolom berikut akan ditambahkan ke setiap objek yang ditampilkan:

Nama Deskripsi Jenis

Nama	Deskripsi	Jenis
time	Awal periode, atau akhir periode seumur hidup.	`datetime`
.	Jumlah, rata-rata, rasio, atau persentase metrik dalam periode tersebut.	`numeric`
breakdowns	Bucket tempat nilai (saat metrik `all_view_durations` digunakan atau jika parameter `breakdown(platform)` ditentukan secara jelas).	`map<string, string>`

time

Awal periode, atau akhir periode seumur hidup.

datetime

Jumlah, rata-rata, rasio, atau persentase metrik dalam periode tersebut.

numeric

breakdowns

Bucket tempat nilai (saat metrik

all_view_durations

digunakan atau jika parameter

breakdown(platform)

ditentukan secara jelas).

map<string, string>

Metrik yang Tersedia

Di bawah ini adalah periode agregat yang tersedia untuk berbagai metrik. Metrik dikumpulkan dari perangkat iOS dan juga Android.

Nama	Deskripsi	Nilai untuk periode
`all_views`	Jumlah tampilan	`day`
`all_view_durations`	Durasi tampilan dengan perincian	`week`
`all_view_durations_average`	Rata-rata durasi tampilan	`week`
`all_scrolls`	Gulir kedalaman dengan perincian	`week`
`all_scrolls_average`	Rata-rata kedalaman gulir	`week`

Contoh

Tampilan artikel harian selama 7 hari terakhir

Untuk meng-kueri perincian harian dari jumlah tampilan salah satu Artikel instan Anda selama 7 hari terakhir, keluarkan permintaan GET berikut:

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

Permintaan ini akan menampilkan tanggapan berikut:

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

Tampilan artikel harian selama 7 hari terakhir dengan perincian platform

Untuk meminta perincian harian dari jumlah tampilan salah satu Artikel Instan Anda selama 7 hari terakhir, selanjutnya diperinci berdasarkan platform tempat Artikel Instan dilihat, keluarkan permintaan GET berikut:

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

Permintaan ini akan menampilkan tanggapan berikut:

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

Durasi tampilan artikel mingguan selama 7 hari terakhir

Untuk meng-kueri perincian mingguan dari durasi tampilan yang sudah dibuat bucket dari salah satu Artikel instan Anda selama 7 hari terakhir, keluarkan permintaan GET berikut:

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

Permintaan ini akan menampilkan tanggapan berikut. Perhatikan bahwa data yang ditampilkan dalam tanggapan ini sudah dibuat bucket:

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