Tool-Referenz

Verfügbar inallen Tarifen

Wenn Sie einen KI-Client mit Cabin verbinden, erhält er Zugriff auf die folgenden Tools. Ihr Assistent entscheidet anhand Ihrer Frage, welche er aufruft. Die Tools sind nach ihrer Wirkung gruppiert:

• Lese-Tools rufen nur Daten ab und können jederzeit gefahrlos laufen.
• Schreib-Tools legen Datensätze an oder ändern sie: Die meisten Clients fragen vorher bei Ihnen nach.
• Löschende Tools entfernen Daten: Clients fragen immer nach, bevor sie diese ausführen.

Jedes Tool arbeitet nur mit Domains in Ihrem eigenen Konto und hält sich an Ihren Tarif. Braucht ein Tool eine Funktion, die Sie nicht haben, sagt es das, statt unvollständige Daten zurückzugeben.

Lese-Tools

list_domains

Listet alle Domains in Ihrem Konto auf, jeweils mit der URL des privaten Dashboards (und der URL des öffentlichen Dashboards, wenn Teilen aktiviert ist). Keine Parameter.

get_analytics

Analytics für eine Domain über einen Zeitraum: Seitenaufrufe, eindeutige Besucher, Sitzungen, Top-Seiten und Referrer.

• domain: die abzufragende Domain (z. B. example.com)
• date_from, date_to: der Zeitraum im Format YYYY-MM-DD
• scope: was enthalten sein soll: core, pages, referrals oder eine Kombination (Standard core)
• limit_lists: Anzahl der Einträge pro Liste (Standard 50)

get_domain_settings

Die aktuellen Einstellungen einer Ihrer Domains: Zeitzone, Status des öffentlichen Dashboards, Empfänger des wöchentlichen Berichts, eigener Skript-Host, Markenfarbe und die Liste ausgeschlossener IPs. Lesen Sie diese Einstellungen, bevor Sie emailRecipients oder excludeIps ändern, denn beide ersetzen jeweils die ganze Liste.

• domain: die zu lesende Domain

validate_installation

Prüft, ob das Tracking-Skript von Cabin auf einer Ihrer Domains richtig installiert ist.

• domain: die zu prüfende Domain

check_custom_domain_dns

Prüft, ob der CNAME einer eigenen Subdomain korrekt auf custom.withcabin.com zeigt.

• custom: die zu prüfende eigene Subdomain (z. B. stats.example.com)

analyse_page

Führt für eine einzelne URL eine Analyse von CO₂, Energie und Performance durch, einschließlich historischer Durchschnittswerte. Bei URLs, die Cabin noch nicht kennt, kann das 20 bis 30 Sekunden dauern.

• url: die vollständige zu analysierende URL (z. B. https://example.com/about)
• force: erneut ausführen, auch wenn schon eine aktuelle Analyse vorliegt (Standard false)

Schreib-Tools

create_domain

Fügt Ihrem Konto eine neue Domain hinzu. Gibt die Dashboard-URL und das Snippet des Tracking-Skripts zum Einbinden zurück.

• domain: die hinzuzufügende Domain (ohne Protokoll oder Pfad)
• tz: IANA-Zeitzone für die Analytics, z. B. Europe/London (Standard UTC)

update_domain_settings

Ändert eine oder mehrere Einstellungen einer Domain, die Ihnen gehört.

• domain: die zu ändernde Domain
• public: das Dashboard öffentlich zugänglich machen
• publicPassword: das öffentliche Dashboard mit einem Passwort schützen; ein leerer String entfernt es (Plus und Scale)
• privacypage: auf dem öffentlichen Dashboard eine Datenschutzerklärung anzeigen
• emailRecipients: Array von E-Mail-Adressen, die den wöchentlichen Bericht dieser Domain erhalten (Plus sendet nur an die E-Mail-Adresse Ihres eigenen Kontos, Scale an beliebige Adressen). Ersetzt die gesamte Liste. Um eine Adresse hinzuzufügen oder zu entfernen, lesen Sie also zuerst die aktuellen Empfänger mit list_domains aus und senden dann die vollständige, aktualisierte Liste. Ein leeres Array stoppt alle wöchentlichen E-Mails.
• tz: IANA-Zeitzone
• color: Markenfarbe des Dashboards (Hex)
• excludeIps: Array mit bis zu 30 IP-Adressen oder CIDR-Bereichen (IPv4 oder IPv6), deren Besuche schon bei der Erfassung verworfen werden. Ersetzt die ganze Liste; mit [] leeren Sie sie. Wenn Sie diese Liste über einen KI-Client setzen oder auslesen, teilen Sie die Adressen mit dem Anbieter dieses Clients.

add_custom_domain

Verknüpft eine eigene Subdomain, sodass das Tracking-Skript von Ihrem eigenen Host ausgeliefert wird und Werbeblocker umgeht. Gibt eine Anleitung zur DNS-Einrichtung zurück und das neue <script>-Tag, das Sie einbinden, sobald der DNS-Eintrag bestätigt ist (Plus und Scale).

• domain: die Cabin-Domain, auf die die Subdomain zeigen soll
• custom: die zu verwendende Subdomain, z. B. stats.example.com (vermeiden Sie Namen wie analytics, tracker oder stats, auf die Werbeblocker selbst abzielen)

Löschende Tools

delete_domain

Entfernt eine Domain dauerhaft aus Ihrem Konto; ihre Analytics-Daten werden anschließend zur Löschung vorgemerkt. Das lässt sich nicht rückgängig machen.

• domain: die zu löschende Domain

remove_custom_domain

Trennt eine eigene Subdomain von einer Ihrer Domains und gibt das Script-Tag mit dem Standard-Host zurück, das Sie wieder in Ihre Website einsetzen.

• domain: die Cabin-Domain, mit der die Subdomain verknüpft ist
• custom: die zu entfernende Subdomain