Content available in: eng | ita
Questo documento descrive il comportamento attuale delle API di Advanced Analytics, incluse le limitazioni note; verrà aggiornato al evolversi delle API.
AccelaSearch tiene traccia di come gli utenti usano la barra di ricerca di uno shop — query, click, filtri, ordinamenti — ed espone statistiche aggregate tramite le API di Advanced Analytics. Gli schemi completi di richiesta/risposta sono documentati in doc/API.yaml; questa pagina spiega a cosa serve ciascun endpoint e come si combinano tra loro.
Tutti gli endpoint riportano dati relativi a un singolo shop, su un intervallo di date, eventualmente limitati a un tipo di dispositivo.
Ogni richiesta richiede l'header X-Accelasearch-Apikey. Lo shop identificato da {id} nel path deve appartenere al customer proprietario della API key, altrimenti la richiesta viene rifiutata.
Tutti gli endpoint sono richieste POST con corpo JSON. I seguenti parametri ricorrono nella maggior parte di essi:
| Parametro | Posizione | Obbligatorio | Note |
|---|---|---|---|
id |
path | sì | Identificatore dello shop. |
| device | body | no | Uno tra all, desktop, mobile. Default all. |
date.startDate |
body | sì | Inizio dell'intervallo di date, timestamp Unix in millisecondi. |
date.endDate |
body | sì | Fine dell'intervallo di date, timestamp Unix in millisecondi. |
| page | body | no | Indice di pagina, base 0. Rilevante solo per gli endpoint che paginano o filtrano parte della risposta (vedi sotto). |
| query | body | variabile | Obbligatorio per query-info. Accettato ma ignorato silenziosamente da facet-info e facets-info — non ha alcun effetto in quei casi. |
| facet | body | variabile | Obbligatorio solo per facet-info: il tipo di facet/filtro su cui riportare (es. brand). |
| Endpoint | Scopo |
|---|---|
POST /API/analytics/{id}/overview |
Panoramica dei KPI (ricerche, search intent, click, exit rate, utilizzo della ricerca) e loro andamento giornaliero. |
POST /API/analytics/{id}/query |
Query più ricercate, prodotti più cliccati, query più frequenti senza risultati. |
POST /API/analytics/{id}/query-info |
Andamento e dettaglio prodotti per una specifica query di ricerca. |
POST /API/analytics/{id}/facet-info |
Dettaglio di utilizzo dei valori di un singolo tipo di facet (filtro). |
POST /API/analytics/{id}/facets-info |
Utilizzo complessivo di facet e opzioni di ordinamento, oltre ai valori di filtro migliori/peggiori. |
Restituisce i principali indicatori di performance del periodo, ciascuno accompagnato dalla variazione percentuale rispetto al periodo immediatamente precedente di pari durata: ricerche totali, search intent, click sui prodotti, exit rate (numero medio di search intent per sessione che ha usato la ricerca) ed il tasso di utilizzo della barra di ricerca. Restituisce inoltre un dettaglio giornaliero (columns + data) allineato giorno per giorno sull'intervallo, con l'etichetta del giorno della settimana per ciascuna voce.
Restituisce tre liste ordinate — query più ricercate, prodotti più cliccati e query che non hanno prodotto risultati — paginate a 20 elementi per pagina. Da notare che le pagine 0 e 1 restituiscono attualmente la stessa prima pagina.
Data una specifica query, restituisce il suo andamento giornaliero di search intent e i prodotti mostrati per essa. La lista prodotti (queryProducts) viene incluso solo quando page è 0 o omesso; le sue tre sotto-liste (all, filters, query) contengono attualmente lo stesso contenuto.