Visits

List visits

Visits (page views stitched by the tag), newest first, each with a one-line summary. A visit is listed when any of its page views matches the filters.

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}/sessions

Request

  • Base URL: https://hootlens-api-368877148687.us-east1.run.app
  • URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/sessions
  • 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.

Query parameters

cursorstring

Pass the nextCursor of the previous page to continue.

limitinteger

Page size.

pathstring

Exact recorded page path.

groupstring

Page group ID, as shown in heatmap cohorts.

localestring

Primary language code such as es.

variantstring

Experiment variant.

tagstring

Only recordings the team tagged with this lower-case tag.

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

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

minDurationMsinteger

Minimum duration in milliseconds.

signal'rage' | 'dead' | 'error'

Only page views with this kind of snag: rage is a pile-up, dead a no-show, error a misfire.

controlled'exclude' | 'include' | 'only'

Test visits (from Playwright runs) are excluded by default; include lists both, only lists just test visits.

automated'exclude' | 'include' | 'only'

Automated visits (bots, headless browsers, scripted clicking) are excluded by default; include lists both, only lists just those.

internal'exclude' | 'include' | 'only'

Internal visits (made by the site's own team, through the internal link or from a listed address) are excluded by default; include lists both, only lists just those.

goalstring

Only page views that converted this goal: a goal ID or its name. An unknown goal is a 404.

elementstring

Only page views with a click on this element: a data-hoot-id (home-menu-toggle), an element key as findings and heatmaps list it, or a selector. Matches page views recorded after the filter shipped; each page view remembers its first 60 distinct clicked elements.

utmSourcestring

Campaign source.

utmCampaignstring

Campaign name.

referrerstring

Referrer origin or host.

browser'chrome' | 'safari' | 'firefox' | 'edge' | 'other'

Browser family.

os'windows' | 'macos' | 'ios' | 'android' | 'linux' | 'other'

Operating system family.

newVisitor'true' | 'false'

true for new visitors, false for returning visitors.

segmentIdstring

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

A saved segment ID. Its filters apply under any filters sent with the request.

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.

Response

A page of visits.

nextCursorstring

Pass back as cursor. Absent on the last page.

Changes

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