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

Recupera dati di analytics segmentati per canale di acquisizione.

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

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 nome del canale come value, il numero di visitatori, le entrate suddivise in newRevenue e renewalRevenue e la sua quota di visitatori come percentage. I nomi dei canali sono Direct, Organic search, Paid search, Organic social, Paid social, Referral, Email, A.I., Display, Video, Affiliate, SMS e Audio.

Combinare i filtri

Separa più valori all'interno di un parametro di filtro con |. Passa il nome di un canale a filter_channel su qualsiasi altro report per limitarlo a quel canale (ad esempio filter_channel=Organic search|Paid search).
Esempio di richiesta (curl)
curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/channels?limit=5' \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "value": "Organic search",
      "visitors": 4120,
      "revenue": 8340,
      "newRevenue": 6910,
      "renewalRevenue": 1430,
      "percentage": 38.6
    },
    {
      "value": "Direct",
      "visitors": 2870,
      "revenue": 5120,
      "newRevenue": 4080,
      "renewalRevenue": 1040,
      "percentage": 26.9
    },
    {
      "value": "Organic social",
      "visitors": 1640,
      "revenue": 1980,
      "newRevenue": 1760,
      "renewalRevenue": 220,
      "percentage": 15.4
    },
    {
      "value": "Referral",
      "visitors": 1210,
      "revenue": 2450,
      "newRevenue": 2010,
      "renewalRevenue": 440,
      "percentage": 11.3
    },
    {
      "value": "Email",
      "visitors": 830,
      "revenue": 1760,
      "newRevenue": 1290,
      "renewalRevenue": 470,
      "percentage": 7.8
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 9
  }
}