api-referenceGET
GET
https://analytics.flowsery.com/api/v1/overviewFetch aggregated analytics metrics for your website.
Bearer Token (API key)
Query parameters
| Parameter | Type | Description |
|---|---|---|
startAt | string | ISO 8601 start date/time. Defaults to the last 30 days when omitted. |
endAt | string | ISO 8601 end date/time. Defaults to now when omitted. |
timezone | string | IANA timezone identifier. Falls back to the site's configured timezone. |
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 (Chrome, Safari, Firefox, Edge). Safari includes Mobile Safari automatically. |
filter_os | string | Operating system (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Referrer domain or well-known referrer 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. |
Notes
When no date range is supplied, the API defaults to the last 30 days through now. Conversion rate is expressed as a percentage. Filter values support | for multi-value matching and ! for negation.Example request (curl)
curl --request GET \
--url https://analytics.flowsery.com/api/v1/overview \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"visitors": 12450,
"sessions": 16890,
"bounceRate": 65.32,
"avgSessionDuration": 245678.45,
"avgEngagedTime": 187432.12,
"revenue": 28450,
"renewalRevenue": 6320,
"refundedRevenue": 410,
"revenuePerVisitor": 2.29,
"conversionRate": 1.15,
"kpiValue": 28450,
"kpiPerVisitor": 2.29,
"kpiConversionRate": 1.15,
"currency": "USD"
}
]
}