api-referenceGET
GEThttps://analytics.flowsery.com/analytics/api/v1/breakdown

Raggruppa 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.

Bearer token (token del workspace o chiave API del sito)

I token del workspace richiedono un selettore del sito

I token API del workspace possono accedere a tutti i siti del workspace. Passa websiteId 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

ParametroTipoDescrizione
websiteIdstringID del sito da usare con un token API del workspace. Omettilo se ti autentichi con una chiave API del sito.
domainstringDominio 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

ParametroTipoDescrizione
dimensionOBBLIGATORIOstringL'attributo con cui raggruppare i visitatori: uno dei 25 valori elencati in Dimensioni. Qualsiasi altro valore restituisce 400.
startAtstringData/ora di inizio in formato ISO 8601 (ad esempio 2024-01-01T00:00:00Z). Se omessa, vengono usati gli ultimi 30 giorni.
endAtstringData/ora di fine in formato ISO 8601. Se omessa, viene usato il momento attuale.
timezonestringFuso orario per l'aggregazione (ad esempio UTC, America/New_York). Se assente, viene usato il fuso orario configurato per il sito.
limitnumberNumero massimo di righe da restituire (1-1000, predefinito: 100).
offsetnumberRighe da saltare per la paginazione (minimo 0, predefinito: 0).

Dimensioni

ParametroTipoDescrizione
devicestringTipo di dispositivo: Desktop, Mobile o Tablet.
pagestringPercorso della pagina.
entry_pagestringPrima pagina della sessione.
exit_linkstringLink in uscita su cui un visitatore ha fatto clic per lasciare il sito. Le entrate sono sempre 0.
hostnamestringHostname da cui è stata servita la pagina.
referrerstringNome della sorgente del referrer come Google, oppure il dominio per i siti che Flowsery non riconosce. Le righe includono iconUrl.
channelstringCanale di acquisizione, le stesse righe di GET /channels.
campaignstringCampagna UTM, le stesse righe di GET /campaigns.
goalstringNome dell'obiettivo. visitors contiene il numero di completamenti e le entrate sono sempre 0.
countrystringNome del paese. Le righe includono countryCode.
regionstringRegione o stato con il nome completo, come California. Le righe includono countryCode.
citystringNome della città. Le righe includono countryCode.
browserstringNome del browser.
browser_versionstringVersione del browser.
osstringSistema operativo.
os_versionstringVersione del sistema operativo.
utm_sourcestringIl parametro URL utm_source.
utm_mediumstringIl parametro URL utm_medium.
utm_campaignstringIl parametro URL utm_campaign.
utm_termstringIl parametro URL utm_term.
utm_contentstringIl parametro URL utm_content.
refstringIl parametro URL ref.
sourcestringIl parametro URL source.
viastringIl parametro URL via, usato spesso per i link di affiliazione e dei partner.
all_paramsstringTutti i parametri di tracciamento della sessione uniti in un unico valore, come utm_source=google&utm_medium=cpc.

Parametri di filtro

ParametroTipoDescrizione
filter_countrystringNome del paese come restituito da /countries, ad esempio United States. Usa | per più valori, ! per escludere e ~ per cercare una parte del valore.
filter_regionstringNome della regione o dello stato come restituito da /regions, ad esempio California.
filter_citystringNome della città.
filter_devicestringTipo di dispositivo: Desktop, Mobile o Tablet. I valori distinguono tra maiuscole e minuscole.
filter_browserstringNome del browser. Safari include in automatico Mobile Safari.
filter_osstringSistema operativo (Mac OS, Windows, iOS, Android).
filter_referrerstringReferrer come restituito da /referrers: un nome di sorgente come Google per i siti riconosciuti, altrimenti il dominio.
filter_refstringIl valore del parametro URL ref.
filter_sourcestringIl valore del parametro URL source.
filter_viastringIl valore del parametro URL via.
filter_utm_sourcestringSorgente UTM.
filter_utm_mediumstringMezzo UTM.
filter_utm_campaignstringCampagna UTM.
filter_utm_termstringTermine UTM.
filter_utm_contentstringContenuto UTM.
filter_pagestringPercorso o URL della pagina.
filter_entry_pagestringPercorso o URL della pagina di ingresso.
filter_hostnamestringHostname/dominio.
filter_channelstringCanale di marketing.
filter_goalstringNome 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 parametri filter_*, 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 esempio dimension=via&filter_country=United States&filter_device=Mobile).
Esempio di richiesta (curl)
curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
  --header 'Authorization: Bearer <api-key>'
200
{
  "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
  }
}