API Reference

Regions

Name: Flowsery
Author: Flowsery

Retrieve region breakdown

GEThttps://analytics.flowsery.com/regions

Fetch analytics data segmented by region.

Bearer Token (API key)

Query parameters

Parameter	Type	Description
`startAt`	`string`	ISO 8601 start date/time (e.g., 2024-01-01T00:00:00Z). Omit for all-time data.
`endAt`	`string`	ISO 8601 end date/time. Must accompany startAt when filtering by date range.
`timezone`	`string`	Timezone for aggregation (e.g., UTC, America/New_York). Falls back to the 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.
`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 (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Referrer domain or well-known name.
`filter_ref`	`string`	The ref URL parameter value.
`filter_source`	`string`	The source URL parameter value.
`filter_via`	`string`	The via URL parameter value.
`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 or URL.
`filter_entry_page`	`string`	Entry page path or URL.
`filter_hostname`	`string`	Hostname/domain.
`filter_channel`	`string`	Marketing channel.
`filter_goal`	`string`	Goal name.

Response fields

Each item in the <code>data</code> array contains the region name, visitor count, and revenue attributed to that region.

Combining filters

Pass comma-separated values within a single filter parameter to match multiple items. Combine different filter parameters to narrow results further (e.g., <code>filter_country=United States&filter_region=California</code>).