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

Haal analytics-data op, uitgesplitst per verwijzende bron.

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.

Optionele parameters

ParameterTypeBeschrijving
startAtstringStartdatum/-tijd in ISO 8601. 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 je site.
limitnumberMaximaal aantal rijen om terug te geven (1-1000, standaard: 100).
offsetnumberAantal rijen om over te slaan voor paginering (min. 0, standaard: 0).

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.
filter_referrerstringReferrer zoals /referrers die teruggeeft: een bronnaam zoals Google voor herkende sites, anders het domein.
filter_refstringDe URL-parameter ref.
filter_sourcestringDe URL-parameter source.
filter_viastringDe 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.
filter_entry_pagestringPad van de instappagina.
filter_hostnamestringHostnaam/domein.
filter_channelstringMarketingkanaal.
filter_goalstringGoalnaam.
Voorbeeldverzoek (curl)
curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/referrers \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "value": "x.com",
      "visitors": 3450,
      "revenue": 1240,
      "newRevenue": 1120,
      "renewalRevenue": 120,
      "percentage": 29.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/x.com.ico"
    },
    {
      "value": "Direct/None",
      "visitors": 2890,
      "revenue": 4560,
      "newRevenue": 3650,
      "renewalRevenue": 910,
      "percentage": 24.4,
      "iconUrl": null
    },
    {
      "value": "example.com",
      "visitors": 2150,
      "revenue": 2890,
      "newRevenue": 2280,
      "renewalRevenue": 610,
      "percentage": 18.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/example.com.ico"
    },
    {
      "value": "Google",
      "visitors": 1840,
      "revenue": 6780,
      "newRevenue": 5080,
      "renewalRevenue": 1700,
      "percentage": 15.6,
      "iconUrl": "https://icons.duckduckgo.com/ip3/google.com.ico"
    },
    {
      "value": "newsletter.example.com",
      "visitors": 1230,
      "revenue": 2150,
      "newRevenue": 1720,
      "renewalRevenue": 430,
      "percentage": 10.4,
      "iconUrl": "https://icons.duckduckgo.com/ip3/newsletter.example.com.ico"
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 119
  }
}