Funnels

Funnel statistics

Visits that reached each step in order, with drop-off examples. Cohort filters match the page view where the visit reached step 1. Ranges are limited to 92 days and default to the last 30.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

get/v1/projects/{projectId}/funnels/{funnelId}/stats

Request

  • Base URL: https://hootlens-api-368877148687.us-east1.run.app
  • URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/funnels/{funnelId}/stats
  • Auth: HTTP bearer

Path parameters

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

The project ID. Project IDs are public identifiers, not secrets.

funnelIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

A funnel ID.

Query parameters

frominteger

Start of the range, epoch milliseconds. Counts are daily, so the range covers every UTC day it touches.

tointeger

End of the range, epoch milliseconds. Defaults to now.

pageGroupstring

Page group ID of the entry page view.

deviceClass'desktop' | 'tablet' | 'mobile'

Device class. Viewports are bucketed by device class, never by exact pixel size.

localestring

Primary language code such as es.

variantstring

Experiment variant of the entry page view.

pageVersionstring

Page version of the entry page view.

Response

The statistics.

funnelIdstring required
namestring required
frominteger required

Epoch milliseconds.

tointeger required

Epoch milliseconds.

effectiveFrominteger

The window measured: from raised to the latest goal start.

effectiveTointeger

Epoch milliseconds.

sessionsinteger required

Visits that reached step 1.

truncatedboolean required

True when only the newest visits were counted.

filtersobject required
notesstring[] required

Changes

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