https://analytics.flowsery.com/analytics/api/v1/breakdownRaggruppa i visitatori per una qualsiasi di 25 dimensioni, comprese quelle senza un endpoint dedicato come entry_page, exit_link, browser_version, os_version, via e i singoli parametri UTM.
I token del workspace richiedono un selettore del sito
I token API del workspace possono accedere a tutti i siti del workspace. PassawebsiteId o domain perché Flowsery sappia quale sito interrogare o modificare. Le chiavi API del sito sono già limitate a un sito, quindi puoi omettere il selettore.Selettore del sito
| Parametro | Tipo | Descrizione |
|---|---|---|
websiteId | string | ID del sito da usare con un token API del workspace. Omettilo se ti autentichi con una chiave API del sito. |
domain | string | Dominio del sito da usare con un token API del workspace quando websiteId non è indicato. Omettilo se ti autentichi con una chiave API del sito. |
Parametri della query
| Parametro | Tipo | Descrizione |
|---|---|---|
dimensionOBBLIGATORIO | string | L'attributo con cui raggruppare i visitatori: uno dei 25 valori elencati in Dimensioni. Qualsiasi altro valore restituisce 400. |
startAt | string | Data/ora di inizio in formato ISO 8601 (ad esempio 2024-01-01T00:00:00Z). Se omessa, vengono usati gli ultimi 30 giorni. |
endAt | string | Data/ora di fine in formato ISO 8601. Se omessa, viene usato il momento attuale. |
timezone | string | Fuso orario per l'aggregazione (ad esempio UTC, America/New_York). Se assente, viene usato il fuso orario configurato per il sito. |
limit | number | Numero massimo di righe da restituire (1-1000, predefinito: 100). |
offset | number | Righe da saltare per la paginazione (minimo 0, predefinito: 0). |
Dimensioni
| Parametro | Tipo | Descrizione |
|---|---|---|
device | string | Tipo di dispositivo: Desktop, Mobile o Tablet. |
page | string | Percorso della pagina. |
entry_page | string | Prima pagina della sessione. |
exit_link | string | Link in uscita su cui un visitatore ha fatto clic per lasciare il sito. Le entrate sono sempre 0. |
hostname | string | Hostname da cui è stata servita la pagina. |
referrer | string | Nome della sorgente del referrer come Google, oppure il dominio per i siti che Flowsery non riconosce. Le righe includono iconUrl. |
channel | string | Canale di acquisizione, le stesse righe di GET /channels. |
campaign | string | Campagna UTM, le stesse righe di GET /campaigns. |
goal | string | Nome dell'obiettivo. visitors contiene il numero di completamenti e le entrate sono sempre 0. |
country | string | Nome del paese. Le righe includono countryCode. |
region | string | Regione o stato con il nome completo, come California. Le righe includono countryCode. |
city | string | Nome della città. Le righe includono countryCode. |
browser | string | Nome del browser. |
browser_version | string | Versione del browser. |
os | string | Sistema operativo. |
os_version | string | Versione del sistema operativo. |
utm_source | string | Il parametro URL utm_source. |
utm_medium | string | Il parametro URL utm_medium. |
utm_campaign | string | Il parametro URL utm_campaign. |
utm_term | string | Il parametro URL utm_term. |
utm_content | string | Il parametro URL utm_content. |
ref | string | Il parametro URL ref. |
source | string | Il parametro URL source. |
via | string | Il parametro URL via, usato spesso per i link di affiliazione e dei partner. |
all_params | string | Tutti i parametri di tracciamento della sessione uniti in un unico valore, come utm_source=google&utm_medium=cpc. |
Parametri di filtro
| Parametro | Tipo | Descrizione |
|---|---|---|
filter_country | string | Nome del paese come restituito da /countries, ad esempio United States. Usa | per più valori, ! per escludere e ~ per cercare una parte del valore. |
filter_region | string | Nome della regione o dello stato come restituito da /regions, ad esempio California. |
filter_city | string | Nome della città. |
filter_device | string | Tipo di dispositivo: Desktop, Mobile o Tablet. I valori distinguono tra maiuscole e minuscole. |
filter_browser | string | Nome del browser. Safari include in automatico Mobile Safari. |
filter_os | string | Sistema operativo (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Referrer come restituito da /referrers: un nome di sorgente come Google per i siti riconosciuti, altrimenti il dominio. |
filter_ref | string | Il valore del parametro URL ref. |
filter_source | string | Il valore del parametro URL source. |
filter_via | string | Il valore del parametro URL via. |
filter_utm_source | string | Sorgente UTM. |
filter_utm_medium | string | Mezzo UTM. |
filter_utm_campaign | string | Campagna UTM. |
filter_utm_term | string | Termine UTM. |
filter_utm_content | string | Contenuto UTM. |
filter_page | string | Percorso o URL della pagina. |
filter_entry_page | string | Percorso o URL della pagina di ingresso. |
filter_hostname | string | Hostname/dominio. |
filter_channel | string | Canale di marketing. |
filter_goal | string | Nome dell'obiettivo. |
Campi della risposta
Ogni elemento dell'array data contiene il valore raggruppato come value, il numero di visitatori, le entrate suddivise in newRevenue e renewalRevenue e la sua quota di visitatori come percentage. Le dimensioni geografiche aggiungono countryCode e referrer aggiunge iconUrl. Un valore non rilevato viene restituito come Unknown.
I valori corrispondono ai filtri
I valori vengono restituiti nella forma che si aspettano i parametrifilter_*, quindi qualsiasi riga può essere rinviata come filtro. Le regioni hanno il nome completo (California, non CA), i dispositivi hanno l'iniziale maiuscola (Desktop, Mobile, Tablet) e i referrer sono nomi di sorgenti (Google, non google.com).Combinare i filtri
Separa più valori all'interno di un parametro di filtro con |. Combina una dimensione con i filtri per rispondere a domande più specifiche (ad esempiodimension=via&filter_country=United States&filter_device=Mobile).curl --request GET \
--url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
--header 'Authorization: Bearer <api-key>'{
"status": "success",
"data": [
{
"value": "partner_anna",
"visitors": 640,
"revenue": 2310,
"newRevenue": 1980,
"renewalRevenue": 330,
"percentage": 51.2
},
{
"value": "partner_marc",
"visitors": 410,
"revenue": 1270,
"newRevenue": 1270,
"renewalRevenue": 0,
"percentage": 32.8
},
{
"value": "podcast",
"visitors": 200,
"revenue": 380,
"newRevenue": 290,
"renewalRevenue": 90,
"percentage": 16
}
],
"pagination": {
"limit": 3,
"offset": 0,
"total": 14
}
}