https://analytics.flowsery.com/analytics/api/v1/breakdownGroepeer bezoekers op een van 25 dimensies, ook dimensies zonder eigen endpoint zoals entry_page, exit_link, browser_version, os_version, via en de afzonderlijke UTM-parameters.
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 |
|---|---|---|
dimensionVERPLICHT | string | Het kenmerk waarop je bezoekers groepeert: een van de 25 waarden onder Dimensies. Elke andere waarde geeft 400. |
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). |
Dimensies
| Parameter | Type | Beschrijving |
|---|---|---|
device | string | Apparaattype: Desktop, Mobile of Tablet. |
page | string | Paginapad. |
entry_page | string | Eerste pagina van de sessie. |
exit_link | string | Uitgaande link waarop een bezoeker klikte om de site te verlaten. Omzet is altijd 0. |
hostname | string | Hostnaam waarvandaan de pagina werd geserveerd. |
referrer | string | Naam van de verwijzende bron, zoals Google, of het domein voor sites die Flowsery niet herkent. Rijen bevatten iconUrl. |
channel | string | Acquisitiekanaal, dezelfde rijen als GET /channels. |
campaign | string | UTM-campagne, dezelfde rijen als GET /campaigns. |
goal | string | Goalnaam. visitors bevat het aantal voltooiingen en omzet is altijd 0. |
country | string | Landnaam. Rijen bevatten countryCode. |
region | string | Regio of staat als volledige naam, zoals California. Rijen bevatten countryCode. |
city | string | Naam van de stad. Rijen bevatten countryCode. |
browser | string | Browsernaam. |
browser_version | string | Browserversie. |
os | string | Besturingssysteem. |
os_version | string | Versie van het besturingssysteem. |
utm_source | string | De URL-parameter utm_source. |
utm_medium | string | De URL-parameter utm_medium. |
utm_campaign | string | De URL-parameter utm_campaign. |
utm_term | string | De URL-parameter utm_term. |
utm_content | string | De URL-parameter utm_content. |
ref | string | De URL-parameter ref. |
source | string | De URL-parameter source. |
via | string | De URL-parameter via, vaak gebruikt voor affiliate- en partnerlinks. |
all_params | string | Alle trackingparameters van de sessie samengevoegd tot één waarde, zoals utm_source=google&utm_medium=cpc. |
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 gegroepeerde waarde als value, het aantal bezoekers, de omzet uitgesplitst in newRevenue en renewalRevenue, en het aandeel bezoekers als percentage. Geografische dimensies voegen countryCode toe en referrer voegt iconUrl toe. Een waarde die niet is vastgelegd, komt terug als Unknown.
Waarden passen bij de filters
Waarden komen terug in de vorm die defilter_*-parameters verwachten, dus elke rij kun je weer als filter meesturen. Regio's zijn volledige namen (California, niet CA), apparaten beginnen met een hoofdletter (Desktop, Mobile, Tablet) en referrers zijn bronnamen (Google, niet google.com).Filters combineren
Scheid meerdere waarden binnen één filterparameter met |. Combineer een dimensie met filters om specifiekere vragen te beantwoorden (bijv.dimension=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
}
}