Plattform-Verfügbarkeit von Kennzahlen (API)

Wenn Sie Streaming-Analytics über die öffentliche LabelGrid-API abrufen und nach einer einzelnen Plattform filtern, teilt Ihnen die Antwort mit, ob diese Plattform die angeforderte Kennzahl tatsächlich meldet. So kann Ihre Integration zwischen „noch keine Daten” und „diese Plattform meldet diese Kennzahl nie” unterscheiden.

Das Feld availability

Fügen Sie einer beliebigen Analytics-Anfrage einen Plattformfilter hinzu — zum Beispiel filter[platform]=SPOTIFY — und die Antwort enthält neben dem gewohnten data ein Feld availability:

• available — die Plattform meldet diese Kennzahl; data wird wie gewohnt gefüllt.
• not_available_for_platform — die Plattform meldet diese Kennzahl nicht. data wird leer zurückgegeben. Das ist erwartetes Verhalten, kein Fehler.

Das Feld availability erscheint nur, wenn Sie nach einer einzelnen Plattform filtern. Anfragen ohne Plattformfilter geben data genau wie zuvor zurück, ohne einen availability-Schlüssel.

Die Form von data bleibt unverändert — availability wird daneben hinzugefügt, sodass bestehende Integrationen ohne Änderung weiter funktionieren.

Endpoints für einzelne Kennzahlen

Jeder eigenständige Analytics-Endpoint gibt neben seinem data einen einzelnen availability-Wert auf oberster Ebene zurück:

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

Der Analytics-Summary-Endpoint

Der Endpoint /analysen/summary gibt mehrere Abschnitte auf einmal zurück. Er trägt eine parallele availability-Zuordnung mit einem Eintrag pro Abschnitt, sodass Sie erkennen können, welche Abschnitte die Plattform meldet und welche leer zurückkommen:

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

Welche Plattform welche Kennzahlen meldet

Plattform (filter[platform])	Gemeldete Kennzahlen
SPOTIFY	Alle Analytics-Kennzahlen
APPLE_MUSIC (ITUNES wird ebenfalls akzeptiert)	Streams, Hörer, Streams nach Land, Streams nach Geschlecht und Streams nach Alter

Bei Apple Music gibt jede Kennzahl außerhalb dieser Liste not_available_for_platform mit leerem data zurück. Spotify meldet jede Analytics-Kennzahl.

Umgang damit in Ihrer Integration

• Lesen Sie availability, bevor Sie ein leeres data als „keine Aktivität” interpretieren. Ein leeres Ergebnis mit not_available_for_platform bedeutet, dass die Plattform diese Kennzahl überhaupt nicht meldet.
• Wenn Sie mehrere Kennzahlen gleichzeitig über /analysen/summary abrufen, prüfen Sie für jeden Abschnitt den passenden Schlüssel in der availability-Zuordnung.
• Wenn Sie nicht nach Plattform filtern, gibt es kein availability-Feld — die Antwort ist die kombinierte Ansicht über alle Plattformen, genau wie zuvor.

Verwandt

• API-Überblick — Authentifizierung, Endpoints und die vollständige Referenz
• Analytics — das Analytics-Dashboard und was jeder Tab zeigt