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

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

Bearer-token (werkruimtetoken of website-API-sleutel)

Werkruimtetokens hebben een websiteselector nodig

Werkruimte-API-tokens hebben toegang tot elke website in de werkruimte. Geef websiteId 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

ParameterTypeBeschrijving
websiteIdstringWebsite-ID om te gebruiken met een werkruimte-API-token. Laat weg als je authenticeert met een website-API-sleutel.
domainstringWebsitedomein 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

ParameterTypeBeschrijving
dimensionVERPLICHTstringHet kenmerk waarop je bezoekers groepeert: een van de 25 waarden onder Dimensies. Elke andere waarde geeft 400.
startAtstringStartdatum/-tijd in ISO 8601 (bijv. 2024-01-01T00:00:00Z). Standaard de laatste 30 dagen als je dit weglaat.
endAtstringEinddatum/-tijd in ISO 8601. Standaard nu als je dit weglaat.
timezonestringTijdzone voor de aggregatie (bijv. UTC, America/New_York). Valt terug op de ingestelde tijdzone van de site.
limitnumberMaximaal aantal rijen om terug te geven (1-1000, standaard: 100).
offsetnumberAantal rijen om over te slaan voor paginering (min. 0, standaard: 0).

Dimensies

ParameterTypeBeschrijving
devicestringApparaattype: Desktop, Mobile of Tablet.
pagestringPaginapad.
entry_pagestringEerste pagina van de sessie.
exit_linkstringUitgaande link waarop een bezoeker klikte om de site te verlaten. Omzet is altijd 0.
hostnamestringHostnaam waarvandaan de pagina werd geserveerd.
referrerstringNaam van de verwijzende bron, zoals Google, of het domein voor sites die Flowsery niet herkent. Rijen bevatten iconUrl.
channelstringAcquisitiekanaal, dezelfde rijen als GET /channels.
campaignstringUTM-campagne, dezelfde rijen als GET /campaigns.
goalstringGoalnaam. visitors bevat het aantal voltooiingen en omzet is altijd 0.
countrystringLandnaam. Rijen bevatten countryCode.
regionstringRegio of staat als volledige naam, zoals California. Rijen bevatten countryCode.
citystringNaam van de stad. Rijen bevatten countryCode.
browserstringBrowsernaam.
browser_versionstringBrowserversie.
osstringBesturingssysteem.
os_versionstringVersie van het besturingssysteem.
utm_sourcestringDe URL-parameter utm_source.
utm_mediumstringDe URL-parameter utm_medium.
utm_campaignstringDe URL-parameter utm_campaign.
utm_termstringDe URL-parameter utm_term.
utm_contentstringDe URL-parameter utm_content.
refstringDe URL-parameter ref.
sourcestringDe URL-parameter source.
viastringDe URL-parameter via, vaak gebruikt voor affiliate- en partnerlinks.
all_paramsstringAlle trackingparameters van de sessie samengevoegd tot één waarde, zoals utm_source=google&utm_medium=cpc.

Filterparameters

ParameterTypeBeschrijving
filter_countrystringLandnaam 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_regionstringNaam van de regio of staat zoals /regions die teruggeeft, bijv. California.
filter_citystringNaam van de stad.
filter_devicestringApparaattype: Desktop, Mobile of Tablet. Waarden zijn hoofdlettergevoelig.
filter_browserstringBrowsernaam. Safari omvat automatisch ook Mobile Safari.
filter_osstringBesturingssysteem (Mac OS, Windows, iOS, Android).
filter_referrerstringReferrer zoals /referrers die teruggeeft: een bronnaam zoals Google voor herkende sites, anders het domein.
filter_refstringDe waarde van de URL-parameter ref.
filter_sourcestringDe waarde van de URL-parameter source.
filter_viastringDe waarde van de URL-parameter via.
filter_utm_sourcestringUTM-bron.
filter_utm_mediumstringUTM-medium.
filter_utm_campaignstringUTM-campagne.
filter_utm_termstringUTM-term.
filter_utm_contentstringUTM-content.
filter_pagestringPaginapad of URL.
filter_entry_pagestringPad of URL van de instappagina.
filter_hostnamestringHostnaam/domein.
filter_channelstringMarketingkanaal.
filter_goalstringGoalnaam.

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 de filter_*-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).
Voorbeeldverzoek (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
  }
}