SettingsSet the autocapture override

Set the autocapture override

Set the location's autocapture override. Requires an agency key (ak_) and ?location_id=; viewer keys get 403 agency_required.

Accepted values for autocapture:

  • false — turn autocapture off for this location. This is the only server-side kill switch; it overrides whatever the site's own init() snippet asks for.
  • true — on with SDK defaults (links and forms). - { "elements": [...] } — on, capturing only those element types. Valid values: links, forms, buttons, inputs, selects, textareas, changes. An empty array is rejected — send false to disable instead. Unknown names are rejected rather than ignored, so a typo cannot silently stop capture.
  • null — clear the override and fall back to the SDK default (on, links + forms).

Note that buttons is not in the default set, so <button> clicks are not captured unless you ask for them. Sites whose calls to action are <a> elements styled as buttons are covered by links.

The override is served to the SDK via the remote config endpoint and wins over the site's init() configuration. Browsers pick the change up on their next remote-config fetch; already-open pages keep their current behaviour until they reload.

Two cases where the override does not apply: a site that sets disable_remote_config: true never fetches remote config, and HIPAA-mode locations always have autocapture off regardless of what is stored here.

curl -X PUT "https://mythic-analytics.gulp.workers.dev/client/v1/settings/autocapture" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "autocapture": {
    "elements": [
      "links",
      "forms",
      "buttons"
    ]
  }
}'
{
  "success": true,
  "data": {
    "autocapture": {
      "elements": [
        "links",
        "forms",
        "buttons"
      ]
    }
  }
}
PUT
/autocapture
PUT
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.
Content-Typestring
Required

The media type of the request body

Options: application/json
autocapturestring
Required

false to disable, true for SDK defaults, an object to choose element types, or null to clear the override.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Body

application/json
autocapturestring
Required

false to disable, true for SDK defaults, an object to choose element types, or null to clear the override.

Example:
{"elements":["links","forms","buttons"]}

Responses

successboolean
dataobject