Settings changes

Preview a settings change

Computes what a change to page targeting, goals, funnels, privacy or per-path presets would do, without making it: the exact diff, effects read from the site's own data, warnings and a change token valid for 10 minutes. Owners may change every area; editors goals and funnels. A change that would make privacy looser (removing a mask or block selector, unmasking an input, keeping query strings, a less strict preset, removing or loosening a path preset) is refused with 403 and code privacy_weakening_refused. At most 30 a minute.

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).

post/v1/projects/{projectId}/settings-changes/preview

Request

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

Request body

Response

The preview. changed is false, with no token, when the site already has these settings.

changedboolean required
tokenstring

Pass to apply. Absent when nothing would change.

expiresAtinteger

Epoch milliseconds.

expiresInSecondsinteger
effectsstring[] required
warningsstring[] required
messagestring
nextstring

Changes

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