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

Fetch analytics data segmented by referrer source.

Bearer Token (API key)

Optional parameters

ParameterTypeDescription
startAtstringISO 8601 start date/time. Defaults to the last 30 days when omitted.
endAtstringISO 8601 end date/time. Defaults to now when omitted.
timezonestringTimezone for aggregation (e.g., UTC, America/New_York). Falls back to your site's configured timezone.
limitnumberMaximum rows to return (1-1000, default: 100).
offsetnumberRows to skip for pagination (min 0, default: 0).

Filter parameters

ParameterTypeDescription
filter_countrystringCountry name or code. Use | for multiple values and ! to exclude values.
filter_regionstringRegion or state.
filter_citystringCity name.
filter_devicestringDevice type. Use backend values such as Desktop|Mobile|Tablet, and ! to exclude.
filter_browserstringBrowser name. Safari includes Mobile Safari automatically.
filter_osstringOperating system.
filter_referrerstringReferrer domain or well-known name.
filter_refstringThe ref URL parameter.
filter_sourcestringThe source URL parameter.
filter_viastringThe via URL parameter.
filter_utm_sourcestringUTM source.
filter_utm_mediumstringUTM medium.
filter_utm_campaignstringUTM campaign.
filter_utm_termstringUTM term.
filter_utm_contentstringUTM content.
filter_pagestringPage path.
filter_entry_pagestringEntry page path.
filter_hostnamestringHostname/domain.
filter_channelstringMarketing channel.
filter_goalstringGoal name.
Example request (curl)
curl --request GET \
  --url https://analytics.flowsery.com/api/v1/referrers \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "value": "x.com",
      "visitors": 3450,
      "revenue": 1240,
      "renewalRevenue": 120,
      "percentage": 29.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/x.com.ico"
    },
    {
      "value": "Direct/None",
      "visitors": 2890,
      "revenue": 4560,
      "renewalRevenue": 910,
      "percentage": 24.4,
      "iconUrl": null
    },
    {
      "value": "example.com",
      "visitors": 2150,
      "revenue": 2890,
      "renewalRevenue": 610,
      "percentage": 18.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/example.com.ico"
    },
    {
      "value": "google.com",
      "visitors": 1840,
      "revenue": 6780,
      "renewalRevenue": 1700,
      "percentage": 15.6,
      "iconUrl": "https://icons.duckduckgo.com/ip3/google.com.ico"
    },
    {
      "value": "newsletter.example.com",
      "visitors": 1230,
      "revenue": 2150,
      "renewalRevenue": 430,
      "percentage": 10.4,
      "iconUrl": "https://icons.duckduckgo.com/ip3/newsletter.example.com.ico"
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 119
  }
}