api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/countriesHaal analytics-data op, uitgesplitst per land.
Bearer-token (werkruimtetoken of website-API-sleutel)
Werkruimtetokens hebben een websiteselector nodig
Werkruimte-API-tokens hebben toegang tot elke website in de werkruimte. GeefwebsiteId of domain mee, zodat Flowsery weet welke website je wilt opvragen of wijzigen. Website-API-sleutels horen al bij één website, dus daar kun je de selector weglaten.Websiteselector
| Parameter | Type | Beschrijving |
|---|---|---|
websiteId | string | Website-ID om te gebruiken met een werkruimte-API-token. Laat weg als je authenticeert met een website-API-sleutel. |
domain | string | Websitedomein om te gebruiken met een werkruimte-API-token als er geen websiteId is opgegeven. Laat weg als je authenticeert met een website-API-sleutel. |
Queryparameters
| Parameter | Type | Beschrijving |
|---|---|---|
startAt | string | Startdatum/-tijd in ISO 8601 (bijv. 2024-01-01T00:00:00Z). Standaard de laatste 30 dagen als je dit weglaat. |
endAt | string | Einddatum/-tijd in ISO 8601. Standaard nu als je dit weglaat. |
timezone | string | Tijdzone voor de aggregatie (bijv. UTC, America/New_York). Valt terug op de ingestelde tijdzone van de site. |
limit | number | Maximaal aantal rijen om terug te geven (1-1000, standaard: 100). |
offset | number | Aantal rijen om over te slaan voor paginering (min. 0, standaard: 0). |
Filterparameters
| Parameter | Type | Beschrijving |
|---|---|---|
filter_country | string | Landnaam zoals /countries die teruggeeft, bijv. United States. Gebruik | voor meerdere waarden, ! om uit te sluiten en ~ om op een deel van de waarde te matchen. |
filter_region | string | Naam van de regio of staat zoals /regions die teruggeeft, bijv. California. |
filter_city | string | Naam van de stad. |
filter_device | string | Apparaattype: Desktop, Mobile of Tablet. Waarden zijn hoofdlettergevoelig. |
filter_browser | string | Browsernaam. Safari omvat automatisch ook Mobile Safari. |
filter_os | string | Besturingssysteem (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Referrer zoals /referrers die teruggeeft: een bronnaam zoals Google voor herkende sites, anders het domein. |
filter_ref | string | De waarde van de URL-parameter ref. |
filter_source | string | De waarde van de URL-parameter source. |
filter_via | string | De waarde van de URL-parameter via. |
filter_utm_source | string | UTM-bron. |
filter_utm_medium | string | UTM-medium. |
filter_utm_campaign | string | UTM-campagne. |
filter_utm_term | string | UTM-term. |
filter_utm_content | string | UTM-content. |
filter_page | string | Paginapad of URL. |
filter_entry_page | string | Pad of URL van de instappagina. |
filter_hostname | string | Hostnaam/domein. |
filter_channel | string | Marketingkanaal. |
filter_goal | string | Goalnaam. |
Velden in het antwoord
Elk item in de array data bevat de landnaam als value, de ISO 3166-1 alpha-2-code countryCode, het aantal bezoekers, de omzet uitgesplitst in newRevenue en renewalRevenue, en het aandeel bezoekers als percentage.
Filters combineren
Scheid meerdere waarden binnen één filterparameter met |. Combineer verschillende filterparameters om de resultaten verder te verfijnen (bijv.filter_country=United States|Canada&filter_device=Mobile).Voorbeeldverzoek (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
}
}