API Reference

Referrers

Name: Flowsery
Author: Flowsery

Retrieve referrer source breakdown

GEThttps://analytics.flowsery.com/referrers

Fetch analytics data segmented by referrer source.

Bearer Token (API key)

Optional parameters

Parameter	Type	Description
`startAt`	`string`	ISO 8601 start date/time. Omit for all-time data.
`endAt`	`string`	ISO 8601 end date/time. Must accompany startAt.
`timezone`	`string`	Timezone for aggregation (e.g., UTC, America/New_York). Falls back to your site's configured timezone.
`limit`	`number`	Maximum rows to return (1-1000, default: 100).
`offset`	`number`	Rows to skip for pagination (min 0, default: 0).

Filter parameters

Parameter	Type	Description
`filter_country`	`string`	Country name or code (e.g., filter_country=United States,Canada).
`filter_region`	`string`	Region or state.
`filter_city`	`string`	City name.
`filter_device`	`string`	Device type -- desktop, mobile, tablet.
`filter_browser`	`string`	Browser name. Safari includes Mobile Safari automatically.
`filter_os`	`string`	Operating system.
`filter_referrer`	`string`	Referrer domain or well-known name.
`filter_ref`	`string`	The ref URL parameter.
`filter_source`	`string`	The source URL parameter.
`filter_via`	`string`	The via URL parameter.
`filter_utm_source`	`string`	UTM source.
`filter_utm_medium`	`string`	UTM medium.
`filter_utm_campaign`	`string`	UTM campaign.
`filter_utm_term`	`string`	UTM term.
`filter_utm_content`	`string`	UTM content.
`filter_page`	`string`	Page path.
`filter_entry_page`	`string`	Entry page path.
`filter_hostname`	`string`	Hostname/domain.
`filter_channel`	`string`	Marketing channel.
`filter_goal`	`string`	Goal name.

Example request (curl)

curl --request GET \
  --url https://analytics.flowsery.com/api/v1/referrers \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "referrer": "X",
      "visitors": 3450,
      "revenue": 1240
    },
    {
      "referrer": "Direct/None",
      "visitors": 2890,
      "revenue": 4560
    },
    {
      "referrer": "example.com",
      "visitors": 2150,
      "revenue": 2890
    },
    {
      "referrer": "Google",
      "visitors": 1840,
      "revenue": 6780
    },
    {
      "referrer": "newsletter.example.com",
      "visitors": 1230,
      "revenue": 2150
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 119
  }
}