api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/countriesRecupera dati di analytics segmentati per paese.
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. 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 |
|---|---|---|
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). |
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 nome del paese come value, il suo countryCode ISO 3166-1 alpha-2, il numero di visitatori, le entrate suddivise in newRevenue e renewalRevenue e la sua quota di visitatori come percentage.
Combinare i filtri
Separa più valori all'interno di un parametro di filtro con |. Combina parametri di filtro diversi per restringere ulteriormente i risultati (ad esempiofilter_country=United States|Canada&filter_device=Mobile).Esempio di richiesta (curl)
curl --request GET \
--url 'https://analytics.flowsery.com/analytics/api/v1/countries?limit=5' \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"value": "United States",
"countryCode": "US",
"visitors": 2840,
"revenue": 6780,
"newRevenue": 5040,
"renewalRevenue": 1740,
"percentage": 44.1
},
{
"value": "France",
"countryCode": "FR",
"visitors": 1230,
"revenue": 2450,
"newRevenue": 1920,
"renewalRevenue": 530,
"percentage": 19.1
},
{
"value": "United Kingdom",
"countryCode": "GB",
"visitors": 920,
"revenue": 1450,
"newRevenue": 1130,
"renewalRevenue": 320,
"percentage": 14.3
},
{
"value": "Germany",
"countryCode": "DE",
"visitors": 780,
"revenue": 1230,
"newRevenue": 1020,
"renewalRevenue": 210,
"percentage": 12.1
},
{
"value": "Spain",
"countryCode": "ES",
"visitors": 650,
"revenue": 980,
"newRevenue": 840,
"renewalRevenue": 140,
"percentage": 10.1
}
],
"pagination": {
"limit": 5,
"offset": 0,
"total": 148
}
}