Retrieve page analytics

api-referenceGET

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

Fetch analytics data segmented by page.

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.

Optional 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`	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 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. Safari includes Mobile Safari automatically.
`filter_os`	`string`	Operating system.
`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.
`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/analytics/api/v1/pages?limit=20' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "/",
      "visitors": 8920,
      "revenue": 12450,
      "newRevenue": 9330,
      "renewalRevenue": 3120,
      "percentage": 63.8
    },
    {
      "value": "/pricing",
      "visitors": 2150,
      "revenue": 8934,
      "newRevenue": 6694,
      "renewalRevenue": 2240,
      "percentage": 15.4
    },
    {
      "value": "/about",
      "visitors": 1840,
      "revenue": 0,
      "newRevenue": 0,
      "renewalRevenue": 0,
      "percentage": 13.2
    },
    {
      "value": "/blog",
      "visitors": 1230,
      "revenue": 0,
      "newRevenue": 0,
      "renewalRevenue": 0,
      "percentage": 8.8
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 243
  }
}