Ketersediaan Metrik per Platform (API)

Saat Anda meminta analytics streaming melalui API publik LabelGrid dan memfilter berdasarkan satu platform, respons memberi tahu Anda apakah platform tersebut benar-benar melaporkan metrik yang Anda minta. Ini memungkinkan integrasi Anda membedakan antara “belum ada data” dan “platform ini tidak pernah melaporkan metrik ini”.

Bidang availability

Tambahkan filter platform ke permintaan analytics mana pun — misalnya filter[platform]=SPOTIFY — dan respons akan menyertakan bidang availability di samping data yang biasa:

• available — platform melaporkan metrik ini; data terisi seperti biasa.
• not_available_for_platform — platform tidak melaporkan metrik ini. data dikembalikan kosong. Ini perilaku yang diharapkan, bukan kesalahan.

Bidang availability muncul hanya saat Anda memfilter berdasarkan satu platform. Permintaan tanpa filter platform mengembalikan data persis seperti sebelumnya, tanpa kunci availability.

Bentuk data tidak berubah — availability ditambahkan di sampingnya, sehingga integrasi yang sudah ada tetap berfungsi tanpa modifikasi.

Endpoint metrik tunggal

Setiap endpoint analytics tunggal mengembalikan satu nilai availability tingkat atas di samping data-nya:

{
  "availability": "not_available_for_platform",
  "data": []
}

Endpoint ringkasan analytics

Endpoint /analitik/summary mengembalikan beberapa bagian sekaligus. Ia membawa peta availability paralel dengan satu entri per bagian, sehingga Anda dapat mengetahui bagian mana yang dilaporkan platform dan mana yang kembali kosong:

{
  "availability": {
    "streams": "available",
    "listeners": "available",
    "streams_by_country": "available",
    "streams_by_gender": "available",
    "streams_by_age": "available",
    "saves": "not_available_for_platform"
  },
  "data": { }
}

Platform mana melaporkan metrik apa

Platform (filter[platform])	Metrik yang dilaporkan
SPOTIFY	Semua metrik analytics
APPLE_MUSIC (ITUNES juga diterima)	Stream, pendengar, stream berdasarkan negara, stream berdasarkan gender, dan stream berdasarkan usia

Untuk Apple Music, metrik apa pun di luar daftar itu mengembalikan not_available_for_platform dengan data kosong. Spotify melaporkan setiap metrik analytics.

Cara menanganinya dalam integrasi Anda

• Baca availability sebelum menganggap data kosong sebagai “tidak ada aktivitas”. Hasil kosong dengan not_available_for_platform berarti platform sama sekali tidak melaporkan metrik itu.
• Saat Anda meminta beberapa metrik sekaligus melalui /analitik/summary, periksa kunci yang sesuai dalam peta availability untuk setiap bagian.
• Jika Anda tidak memfilter berdasarkan platform, tidak ada bidang availability — respons adalah tampilan gabungan di seluruh platform, persis seperti sebelumnya.

Terkait

• Ikhtisar API — autentikasi, endpoint, dan referensi lengkap
• Analytics — dasbor analytics dan apa yang ditampilkan setiap tab