Riferimento degli strumenti

Disponibile contutti i piani

Quando colleghi un client IA a Cabin, ottiene accesso agli strumenti qui sotto. È il tuo assistente a scegliere quali usare in base a quello che chiedi. Gli strumenti sono raggruppati in base a cosa fanno:

• Gli strumenti di lettura recuperano solo dati e puoi usarli in qualsiasi momento senza rischi.
• Gli strumenti di scrittura creano o modificano dati: la maggior parte dei client ti chiede prima una conferma.
• Gli strumenti distruttivi rimuovono dati: i client chiedono sempre prima di eseguirli.

Ogni strumento agisce solo sui domini del tuo account e rispetta il tuo piano. Uno strumento che richiede una funzione che non hai te lo dice, invece di restituire dati parziali.

Strumenti di lettura

list_domains

Elenca tutti i domini del tuo account, ognuno con l'URL della sua dashboard privata (e l'URL della dashboard pubblica, se la condivisione è attiva). Nessun parametro.

get_analytics

Statistiche di un dominio in un intervallo di date: visualizzazioni di pagina, visitatori unici, sessioni, pagine principali e referrer.

• domain: il dominio da interrogare (es. example.com)
• date_from, date_to: l'intervallo, nel formato YYYY-MM-DD
• scope: cosa includere: core, pages, referrals o una combinazione (predefinito core)
• limit_lists: numero di elementi da restituire in ogni elenco (predefinito 50)

get_domain_settings

Le impostazioni attuali di uno dei tuoi domini: fuso orario, stato della dashboard pubblica, destinatari del report settimanale, host personalizzato dello script, colore del brand ed elenco degli IP esclusi. Leggile prima di modificare emailRecipients o excludeIps, perché entrambi sostituiscono l'intero elenco.

• domain: il dominio da leggere

validate_installation

Controlla se lo script di tracciamento di Cabin è installato correttamente su uno dei tuoi domini.

• domain: il dominio da controllare

check_custom_domain_dns

Verifica che il CNAME di un sottodominio personalizzato punti correttamente a custom.withcabin.com.

• custom: il sottodominio personalizzato da controllare (es. stats.example.com)

analyse_page

Esegue un'analisi di CO₂/energia e prestazioni su un singolo URL, comprese le medie storiche. Per gli URL che Cabin non ha mai visto possono servire 20 o 30 secondi.

• url: l'URL completo da analizzare (es. https://example.com/about)
• force: ripete l'analisi anche se ne esiste una recente (predefinito false)

Strumenti di scrittura

create_domain

Aggiunge un nuovo dominio al tuo account. Restituisce l'URL della dashboard e lo snippet dello script di tracciamento da installare.

• domain: il dominio da aggiungere (senza protocollo né percorso)
• tz: fuso orario IANA per le statistiche, es. Europe/London (predefinito UTC)

update_domain_settings

Aggiorna una o più impostazioni di un dominio di tua proprietà.

• domain: il dominio da aggiornare
• public: rende la dashboard accessibile pubblicamente
• publicPassword: protegge con una password la dashboard pubblica; una stringa vuota la rimuove (Plus e Scale)
• privacypage: mostra una dichiarazione sulla privacy nella dashboard pubblica
• emailRecipients: array di indirizzi email che ricevono il report settimanale di questo dominio (Plus invia solo all'email del tuo account; Scale invia a chiunque). Sostituisce l'intero elenco, quindi per aggiungere o togliere un indirizzo leggi prima i destinatari attuali con list_domains, poi invia l'elenco completo aggiornato. Un array vuoto interrompe tutte le email settimanali.
• tz: fuso orario IANA
• color: colore del brand della dashboard (esadecimale)
• excludeIps: array di massimo 30 indirizzi IP o intervalli CIDR (IPv4 o IPv6) le cui visite vengono scartate in fase di raccolta. Sostituisce l'intero elenco; passa [] per svuotarlo. Impostare o leggere questo elenco tramite un client IA condivide quegli indirizzi con il fornitore del client.

add_custom_domain

Collega un sottodominio personalizzato in modo che lo script di tracciamento venga servito dal tuo host, aggirando gli ad blocker. Restituisce le istruzioni per configurare il DNS e il nuovo tag <script> da installare dopo la verifica del DNS (Plus e Scale).

• domain: il dominio Cabin a cui punterà il sottodominio
• custom: il sottodominio da usare, es. stats.example.com (evita nomi come analytics, tracker o stats, che sono proprio quelli presi di mira dagli ad blocker)

Strumenti distruttivi

delete_domain

Rimuove in modo definitivo un dominio dal tuo account; le sue statistiche vengono poi programmate per l'eliminazione. L'operazione è irreversibile.

• domain: il dominio da eliminare

remove_custom_domain

Scollega un sottodominio personalizzato da un dominio di tua proprietà e restituisce il tag dello script con l'host predefinito da rimettere nel tuo sito.

• domain: il dominio Cabin a cui è collegato il sottodominio
• custom: il sottodominio da rimuovere