Breakdowns

Break down visitors by acquisition channel

Organic search, paid, social, referral, direct and email, ordered by visitors.

get/channels

Request

  • Base URL: https://analytics.flowsery.com/analytics/api/v1
  • URL: https://analytics.flowsery.com/analytics/api/v1/channels
  • Auth: HTTP bearer

Query parameters

websiteIdstring

Website to query. Optional when the API key is scoped to a single website; required for workspace tokens that span several.

domainstring

Alternative to websiteId: select the website by its domain.

startAtstring date-time

Start of the reporting window (ISO 8601). Defaults to 30 days ago.

endAtstring date-time

End of the reporting window (ISO 8601). Defaults to now.

timezonestring

IANA timezone used to bucket the results, e.g. Europe/Berlin. Defaults to the website timezone.

limitinteger

Maximum rows to return. Defaults to 100.

offsetinteger

Rows to skip before returning results.

filter_countrystring

Keep only rows whose country matches this value.

filter_regionstring

Keep only rows whose region matches this value.

filter_citystring

Keep only rows whose city matches this value.

filter_devicestring

Keep only rows whose device matches this value.

filter_browserstring

Keep only rows whose browser matches this value.

filter_osstring

Keep only rows whose os matches this value.

filter_referrerstring

Keep only rows whose referrer matches this value.

filter_refstring

Keep only rows whose ref matches this value.

filter_sourcestring

Keep only rows whose source matches this value.

filter_viastring

Keep only rows whose via matches this value.

filter_utm_sourcestring

Keep only rows whose utm source matches this value.

filter_utm_mediumstring

Keep only rows whose utm medium matches this value.

filter_utm_campaignstring

Keep only rows whose utm campaign matches this value.

filter_utm_termstring

Keep only rows whose utm term matches this value.

filter_utm_contentstring

Keep only rows whose utm content matches this value.

filter_pagestring

Keep only rows whose page matches this value.

filter_hostnamestring

Keep only rows whose hostname matches this value.

filter_entry_pagestring

Keep only rows whose entry page matches this value.

filter_channelstring

Keep only rows whose channel matches this value.

filter_goalstring

Keep only rows whose goal matches this value.

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

Breakdown rows ordered by visitors, descending.

status'success' required

Changes

No recorded changes to this operation across all 1 revision of this API.