Changes

Impact of a change

Before and after comparison around a change: visits, goal conversion rates, snags per 100 page views, scroll reach and element click shares, with a one-sentence summary and caveats. This is not an A/B test.

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}/changes/{changeId}/impact

Request

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

changeIdstring required

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

A change marker ID.

Query parameters

daysinteger

Days each side runs at most.

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

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

localestring

Primary language code such as es.

Response

The impact report.

daysinteger required
measurementOnlyboolean

True when the change only changed counting: goal verdicts are counting-changed and no rise or fall is claimed.

summarystring required

One sentence with the observed numbers and sample sizes.

caveatsstring[] required
generatedAtinteger required

Epoch milliseconds.

Changes

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