Retrieve campaign analytics

api-referenceGET

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

Fetch analytics data segmented by campaign parameters.

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 <code>websiteId</code> or <code>domain</code> 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 or code. Use \| for multiple values and ! to exclude values.
`filter_region`	`string`	Region or state.
`filter_city`	`string`	City name.
`filter_device`	`string`	Device type. Use backend values such as Desktop\|Mobile\|Tablet, and ! to exclude.
`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/analytics/api/v1/campaigns \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "campaign": {
        "utm_source": "",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": "",
        "ref": "indiepage",
        "source": "",
        "via": ""
      },
      "visitors": 2150,
      "revenue": 3420,
      "renewalRevenue": 810,
      "percentage": 43.4
    },
    {
      "campaign": {
        "utm_source": "newsletter.example.com",
        "utm_medium": "email",
        "utm_campaign": "product-launch-2025",
        "utm_term": "",
        "utm_content": "",
        "ref": "",
        "source": "",
        "via": ""
      },
      "visitors": 1840,
      "revenue": 2890,
      "renewalRevenue": 540,
      "percentage": 37.1
    },
    {
      "campaign": {
        "utm_source": "",
        "utm_medium": "",
        "utm_campaign": "",
        "utm_term": "",
        "utm_content": "",
        "ref": "",
        "source": "",
        "via": "partner"
      },
      "visitors": 920,
      "revenue": 1450,
      "renewalRevenue": 210,
      "percentage": 18.5
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 138
  }
}