Analysis

Weekly summary

The weekly digest as structured data: visits, snags by element, goal conversions, logged changes with their verdicts, funnels and one thing to watch. Example recordings need the replay scope.

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}/weekly-summary

Request

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

weekEndingstring

The last UTC day of the week, YYYY-MM-DD. Defaults to the latest complete week.

includeToday'true' | 'false'

true to include today, which is still in progress.

Response

The digest, and starter funnel suggestions when the site has goals and no funnels.

Changes

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