Get Page Flow Report | Webflow Developer Documentation

curl -G https://api.webflow.com/v2/sites/580e63e98c9a982ac9b8b741/analyze/reports/page_flow \
     -H "Authorization: Bearer <token>" \
     --data-urlencode startTime=2026-04-01T00:00:00Z \
     --data-urlencode endTime=2026-04-08T00:00:00Z \
     -d direction=next \
     -d metricScope=session \
     -d pageId=65f1b2c4a8d3e5f7a9c1b2d3 \
     -d collectionId=66abc1234567890abcdef012 \
     -d itemSlug=anchor-post \
     -d limit=10 \
     -d deviceType=desktop \
     -d country=US \
     --data-urlencode pagePath=/towels \
     -d trafficSource=SO \
     -d referrer=google.com \
     -d browser=Chrome \
     -d utmCampaign=dont-panic-2026 \
     -d utmMedium=email \
     -d utmSource=hitchhikers-guide

{
  "report": "page_flow",
  "window": {
    "startTime": "2026-04-01T00:00:00Z",
    "endTime": "2026-04-08T00:00:00Z"
  },
  "direction": "next",
  "metricScope": "session",
  "pageId": "65f1b2c4a8d3e5f7a9c1b2d3",
  "limit": 10,
  "data": [
    {
      "pageId": "page-pricing",
      "title": "Pricing - Acme",
      "pageName": "Pricing",
      "count": 1820
    },
    {
      "pageId": "page-blog",
      "title": "Launch Post",
      "pageName": "Blog Post",
      "count": 42,
      "collectionId": "66abc1234567890abcdef012",
      "itemSlug": "launch-post"
    }
  ],
  "collectionId": "66abc1234567890abcdef012",
  "itemSlug": "anchor-post",
  "filter": {
    "browser": {
      "eq": "Chrome"
    },
    "country": {
      "eq": "US"
    },
    "deviceType": {
      "eq": "desktop"
    },
    "pagePath": {
      "eq": "/towels"
    },
    "referrer": {
      "eq": "google.com"
    },
    "trafficSource": {
      "eq": "SO"
    },
    "utmCampaign": {
      "eq": "dont-panic-2026"
    },
    "utmMedium": {
      "eq": "email"
    },
    "utmSource": {
      "eq": "hitchhikers-guide"
    }
  }
}

Returns the pages visitors viewed immediately before or after a required anchor page over a time window, ranked by sessions, users, or page views.

For a CMS template instance, provide both collectionId and itemSlug with pageId. Filter the report with top-level query parameters (country, deviceType, pagePath, etc.) or via the filter parameter for multi-value and negation matching.

Analyze add-on required

This endpoint requires a workspace with the Analyze add-on.

Concurrency limit: 1 request at a time

Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return 429 Too Many Requests. Wait for your in-flight request to finish, or for the Retry-After interval, then retry.

Required scope | sites:read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Query parameters

startTimestringRequiredformat: "date-time"

Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in Z (for example, 2026-04-01T00:00:00Z); numeric offsets such as -04:00 or +00:00 are not accepted. Must be on or after 2025-04-09T00:00:00Z.

endTimestringRequiredformat: "date-time"

Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in Z (for example, 2026-04-08T00:00:00Z); numeric offsets such as -04:00 or +00:00 are not accepted. Must be greater than startTime and within 100 days of it.

directionenumRequired

Whether to return pages viewed immediately before or after the anchor page.

Allowed values:

metricScopeenumRequired

The unit each row’s count is measured in.

Allowed values:

pageIdstringRequired>=1 character

Identifier of the anchor Webflow page.

collectionIdstringOptional>=1 character

Identifier of the CMS collection for an anchor template-page instance. Must be provided together with itemSlug, or both must be omitted.

itemSlugstringOptional>=1 character

Slug of the CMS item for an anchor template-page instance. Must be provided together with collectionId, or both must be omitted.

limitintegerOptional1-100Defaults to 10

Maximum number of rows to return. Defaults to 10, up to a maximum of 100.

deviceTypeenumOptional

Restrict the report to a single device type.

Allowed values:

countrystringOptional=2 characters

Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).

pagePathstringOptional

Restrict the report to a single page path.

trafficSourcestringOptional

Restrict the report to a single traffic source code (for example, SO for Organic Search).

referrerstringOptional

Restrict the report to a single referrer domain.

browserstringOptional

Restrict the report to a single browser.

utmCampaignstringOptional

Restrict the report to a single utm_campaign value.

utmMediumstringOptional

Restrict the report to a single utm_medium value.

utmSourcestringOptional

Restrict the report to a single utm_source value.

filterobjectOptional

Filter the report by dimension. Use bracket notation. Scalars take a single value (filter[country][eq]=US, filter[country][ne]=US). Arrays use indexed brackets (filter[country][in][0]=US&filter[country][in][1]=CA, filter[country][nin][0]=US&filter[country][nin][1]=CA). Each dimension entry takes at least one of eq, in, ne, or nin. Filter a given dimension in one place — either a top-level query parameter or a filter entry. See the PageFlowFilter schema for the full list of supported dimensions.

Response

Pages viewed immediately before or after the anchor page, ranked by count.

reportenum

Discriminator identifying the report type.

Allowed values:

windowobject

A reporting time window. endTime must be greater than startTime.

directionenum

Which side of the anchor page to rank.

previous: pages viewed immediately before the anchor page.
next: pages viewed immediately after the anchor page.

Allowed values:

metricScopeenum

The unit each row’s count is measured in.

session: number of sessions.
user: number of unique users.
pageview: number of page views.

Allowed values:

pageIdstring

Identifier of the anchor Webflow page.

limitinteger1-100

The row cap applied to this response, including the default.

datalist of objects

Related pages ranked by count, descending. At most limit rows.

collectionIdstringOptional

Identifier of the CMS collection for the anchor template-page instance. Present with itemSlug when the request targeted a CMS page.

itemSlugstringOptional

Slug of the CMS item for the anchor template-page instance. Present with collectionId when the request targeted a CMS page.

filterobjectOptional

Filter the page flow report by dimension. Each property is an optional set of AnalyzeFilterOperators (eq, in, ne, nin) applied to the named dimension. Filter a given dimension in one place — either inside filter or as a top-level query parameter.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error