> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get Analyze time on page report

> Retrieves time-on-page metrics from Webflow Analyze.

`webflow.getAnalyzeTimeOnPageReport` retrieves time-on-page metrics for a reporting window.

## Example

```ts automations/webflow-get-analyze-time-on-page-report.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { webflow } from "automate.ax/webflow"

export default automation("Get Analyze time on page", () => {
  onDashboardRun({ title: "Get Analyze time on page" })
  webflow.getAnalyzeTimeOnPageReport({
    siteId: "site-id",
    startTime: "2026-08-01T00:00:00Z",
    endTime: "2026-08-08T00:00:00Z",
    metricScope: "session",
  })
})
```

## Inputs

Every input accepts a compatible signal. This action requires the `sites:read` OAuth scope.

| Field           | Type                                                             | Required | Description                                                                               |
| --------------- | ---------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `siteId`        | `string`                                                         | Yes      | Webflow site ID.                                                                          |
| `startTime`     | `string`                                                         | Yes      | Inclusive UTC timestamp ending in `Z`; no earlier than April 9, 2025.                     |
| `endTime`       | `string`                                                         | Yes      | Exclusive UTC timestamp ending in `Z`; after `startTime` and no more than 100 days later. |
| `metricScope`   | `"session" \| "user" \| "pageview"`                              | Yes      | Unit used to compute the average.                                                         |
| `timeseries`    | `{ bucketTimeZone: string; granularityPeriod: "day" \| "week" }` | No       | Adds bucketed values in the supplied IANA time zone.                                      |
| `deviceType`    | `"desktop" \| "mobile" \| "tablet"`                              | No       | Restricts the report to one device type.                                                  |
| `country`       | `string`                                                         | No       | Two-letter country code.                                                                  |
| `pagePath`      | `string`                                                         | No       | Restricts the report to one page path.                                                    |
| `trafficSource` | `string`                                                         | No       | Restricts the report to one traffic-source code.                                          |
| `referrer`      | `string`                                                         | No       | Restricts the report to one referrer domain.                                              |
| `browser`       | `string`                                                         | No       | Restricts the report to one browser.                                                      |
| `utmCampaign`   | `string`                                                         | No       | Restricts the report to one UTM campaign.                                                 |
| `utmMedium`     | `string`                                                         | No       | Restricts the report to one UTM medium.                                                   |
| `utmSource`     | `string`                                                         | No       | Restricts the report to one UTM source.                                                   |
| `filter`        | `object`                                                         | No       | Applies multi-value or negated dimension filters.                                         |

Each `filter` entry accepts at least one of `eq: string`, `ne: string`, `in: string[]`, or `nin: string[]`. Supported keys are `audienceIds`, `browser`, `collectionId`, `country`, `dayOfWeek`, `deviceBrand`, `deviceType`, `domain`, `itemSlug`, `language`, `locale`, `nextCollectionId`, `nextItemSlug`, `nextPageId`, `os`, `pageId`, `pagePath`, `previousCollectionId`, `previousItemSlug`, `previousPageId`, `referrer`, `region`, `timeOfDay`, `timezone`, `trafficSource`, `utmCampaign`, `utmContent`, `utmMedium`, `utmSource`, `utmTerm`, and `visitStatus`.

<Warning>
  Your workspace needs the Webflow Analyze add-on. Webflow permits one Analyze
  request at a time per access token.
</Warning>

## Output

| Field         | Type                                                             | Description                                            |
| ------------- | ---------------------------------------------------------------- | ------------------------------------------------------ |
| `report`      | `"time_on_page"`                                                 | Report discriminator.                                  |
| `window`      | `{ startTime: string; endTime: string }`                         | Applied reporting window.                              |
| `metricScope` | `"session" \| "user" \| "pageview"`                              | Unit used for each average.                            |
| `data`        | `{ averageSeconds: number; timestamp: string }[]`                | One aggregate point or one point per requested bucket. |
| `bucketing`   | `{ bucketTimeZone: string; granularityPeriod: "day" \| "week" }` | Applied bucket settings, when requested.               |
| `filter`      | `object`                                                         | Applied filters, when present.                         |