→ 部分的に可能です。被参照数を直接APIで取得することはできませんが、特定のAPIからの被参照数は取得が可能です。
特定のAPIからの被参照数を取得する方法
例としてブログAPIからコンテンツ参照でカテゴリAPIを参照しているとします。
このとき、カテゴリに対してブログAPIからの被参照数を取得したい場合、カテゴリのコンテンツID(例:sample-category
)を利用します。
参照元のブログAPIで、コンテンツIDを利用して絞り込みをすることで確認できます。
リクエスト例
curl "https://your-service.microcms.io/api/v1/blogs?fields=id&filters=category[equals]sample-category"
レスポンス例
{
"contents": [
{
"id": "wdd22xj18x7"
},
{
"id": "ds3avphpk"
}
],
"totalCount": 2,
"offset": 0,
"limit": 10
}
レスポンスには該当するコンテンツの総数を表すtotalCount
が含まれています。
上記の例では、sample-category
は2つのブログから参照されていることがわかります。この値が、ブログAPIからの被参照数となります。
複数のAPIから参照されている場合
コンテンツが複数のAPI(例: blogs, news, products)から参照されている場合、それぞれのAPIに対して同様のリクエストを実行し、それらのレスポンスを集計する必要があります。
各レスポンスの totalCount
を合計すれば、該当コンテンツの総被参照数を求めることができます。
- 同じコンテンツから2箇所以上で参照されている場合でも被参照数は1となります。
- 複数コンテンツ参照フィールドから参照している場合はfiltersパラメータの条件に[contains]を指定してください。詳しくはヘルプ記事「コンテンツ参照や複数コンテンツ参照のデータを対象に絞り込みを行う方法は?」をご参照ください。