Erste Schritte mit dem API von PageSpeed.ONE

Dieser Text führt Sie durch die ersten Schritte mit dem Monitoring-API von PageSpeed.ONE. Was Sie benötigen, wo Sie den Schlüssel erhalten und wie Sie aus den API-Daten einen Überblick über die Geschwindigkeit Ihrer Websites gewinnen können.

Dieser Text bietet einen schnellen Einstieg in das Thema. Er ersetzt daher nicht die vollständige API-Dokumentation.

Was bietet das API?#

Das öffentliche API dient der Automatisierung der Arbeit mit Testergebnissen:

• Sie können aggregierte CrUX-Metriken abrufen.
• Sie können die Verlaufshistorie der PageSpeed.ONE Score (SPS) einsehen.
• Sie können den Status des Wächters einsehen.
• Sie können Notizen in die Diagramme einfügen.

Wo ist das API verfügbar?#

Das öffentliche Monitoring-API von PageSpeed.ONE ist unter der folgenden URL verfügbar:

Produktions-URL: https://api.pagespeed.one/.

Ein erster Test kann über die Befehlszeile wie folgt durchgeführt werden:

curl https://api.pagespeed.one/health

Dies gibt Ihnen den „Gesundheitszustand“ des API zurück, sodass Sie wissen, dass alles funktioniert.

Automatisieren Sie die Arbeit mit Geschwindigkeitsdaten – Metriken, Wächter und Notizen in Diagrammen.

Welche Voraussetzungen gibt es für den Datenzugriff?#

Der Zugang zum API ist mit den realen Testsätzen von PageSpeed.ONE verknüpft. API-Schlüssel werden für das Team zugewiesen. Sie benötigen einen Tarif und eine Konfiguration im Team, die das API unterstützt:

• Sie müssen in einem Team sein, das einen der bezahlten Testsätze, wie beispielsweise PLUS, zur Verfügung hat.
• Sie müssen in diesem Team Administrator sein, um API-Schlüssel generieren zu können.

Vergewissern Sie sich, dass Sie nach der Anmeldung im Team-Einstellungen die API-Konfiguration sehen können. Dann können Sie mit der Einrichtung der API-Schlüssel fortfahren.

Erhalt eines API-Schlüssels#

Geschützte Anfragen autorisieren Sie mit einem Organisationsschlüssel (auch „Bearer-Token“ genannt). Der Schlüssel gehört einem Team, und alle Operationen können nur mit den Daten dieses Teams durchgeführt werden.

• Melden Sie sich im Browser bei PageSpeed.ONE Monitoring an.
• Wählen Sie das entsprechende Team aus.
• Öffnen Sie die Team-Einstellungen (Organisation).
• Suchen Sie in den Einstellungen den Abschnitt für Öffentliches API und Schlüsselverwaltung.
• Wählen Sie vor der Generierung das Berechtigungsniveau:
  • Nur lesen — für diesen API-Schlüssel ist nur das Lesen von Geschwindigkeitsdaten erlaubt (kann z.B. auch externen Agenturen zugewiesen werden).
  • Lesen und schreiben — für Operationen, die Daten ändern, z.B. das Erstellen von Notizen zu einem Test (Achtung, wem Sie den Schlüssel zuweisen).
• Generieren Sie einen neuen Schlüssel. Kopieren Sie den Schlüssel dann in Ihren Passwortmanager.
• Behandeln Sie den Schlüssel sorgfältig, wie ein Passwort: Verwenden Sie nur HTTPS für die Übertragung, speichern Sie ihn niemals im Repository; bei Datenlecks oder von Zeit zu Zeit den Schlüssel widerrufen und einen neuen erstellen.

Bei jeder Anfrage senden Sie nun den Header Authorization: Bearer <IHR_API_KEY> und können unsere API nutzen.

Wie finde ich den Hash eines bestimmten Testsatzes?#

Testsätze sind Einheiten, die Sie im Dashboard des Teams sehen. Bei PLUS-Tests entsprechen sie der Messung einer Website, ihrer URL und der Konkurrenz.

Den Hash eines Testsatzes finden Sie auch manuell in der URL des entsprechenden Testsatzes:

https://pagespeed.one/app/r/7f3c9a2b1d4e8/

→ testHash ist in diesem Fall 7f3c9a2b1d4e8

Die korrekte URL eines Testsatzes erkennen Sie an der Form /app/r/{testHash}/.

Verwenden Sie keine anderen Segmente aus der Adresse (z.B. den Team-Hash im Pfad /app/{etwas}/dashboard).

Eine vollständige Liste gültiger Hashes von Testsätzen für Ihr Team (PLUS, START einschließlich Testphasen; ohne reine FREE-Messungen) können Sie auch durch einen API-Aufruf von GET /v1/tests erhalten.

Erster Test#

Sie können alle relevanten Testsätze des Teams auflisten (siehe oben). Oder gleich einen bestimmten Hash überprüfen:

Versuchen Sie zu überprüfen, ob Sie Zugang zu dem bestimmten Testsatz haben:

curl 'https://api.pagespeed.one/v1/tests/access-check?testHash=TEST_HASH' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer IHR_API_KEY'

Ersetzen Sie

• IHR_API_KEY — API-Schlüssel, siehe oben,
• TEST_HASH — Test-Hash aus der URL, siehe oben.

Es sollte Ihnen etwas wie Folgendes zurückgegeben werden:

{
  "authorized": true,
  "organizationHash": "TEAM_HASH",
  "testHash": "TEST_HASH"
}

organizationHash entspricht dem Team-Segment in /app/{organizationHash}/dashboard (es ist keine numerische ID aus der Datenbank).

Sie können dies auch live in der vollständigen API-Dokumentation ausprobieren. Dort finden Sie auch weitere Aufrufmöglichkeiten zum Lesen oder Schreiben von Daten.

Fehlerantworten#

Häufige Fälle:

• 401 — Schlüssel fehlt, falsch formatierter Authorization-Header oder Schlüssel wird nicht erkannt,
• 403 — Schlüssel gültig, aber Umfang reicht nicht aus (z.B. nur Leseschlüssel für Schreibvorgänge),
• 500 — unerwarteter Serverfehler.

Der Antwortkörper ist meist ein kleines JSON mit einem error-Feld (Text geeignet für Logs oder UI; der Wortlaut kann sich zwischen den Versionen ändern).

Vollständige API-Dokumentation#

• Systemanfragen
• Liste der Testsätze des Teams
• Arbeiten mit Testdaten