Retrieve site overview

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/overview

Fetch aggregated analytics metrics for your website.

Bearer Token (workspace token or website API key)

Workspace Tokens Need a Website Selector

Workspace API tokens can access every website in the workspace. Pass either websiteId or domain so Flowsery knows which website to query or mutate. Website API keys are already scoped to one website, so the selector can be omitted.

Website Selector

Parameter	Type	Description
`websiteId`	`string`	Website ID to use with a workspace API token. Omit when authenticating with a website API key.
`domain`	`string`	Website domain to use with a workspace API token when websiteId is not provided. Omit when authenticating with a website 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 as returned by /countries, e.g. United States. Use \| for several values, ! to exclude and ~ to match part of the value.
`filter_region`	`string`	Region or state name as returned by /regions, e.g. California.
`filter_city`	`string`	City name.
`filter_device`	`string`	Device type: Desktop, Mobile or Tablet. Values are case-sensitive.
`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 as returned by /referrers: a source name such as Google for recognized sites, otherwise the domain.
`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. bounceRate and conversionRate are percentages; avgSessionDuration and avgEngagedTime are seconds. Filter values accept | for several values, ! to exclude and ~ to match part of the value.

Example Request (Curl)

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

200

{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 246,
      "avgEngagedTime": 187,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}