Visits

Narrative of a visit

A step-by-step account of a whole visit, up to 25 page views. Observed behavior only; it never states emotion or intent. The person behind the credential must hold the replay permission on the site (403 replay_required otherwise).

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/{sessionId}/narrative

Request

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

sessionIdstring required

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

A visit ID (a session in the API): the page views of one visit.

Response

The narrative.

summarystring required
omittedStepsinteger required
omittedPagesinteger required
notestring
annotationsobject

The team's own notes and tags: free text a person wrote, never captured from visitors.

Changes

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