Sites

Set the site's dashboard icon

Initials on a colored tile, or the site's favicon (fetched from https://{domain}/ and stored).

put/api/sites/{siteId}/icon

Request

  • Base URL: https://slimlytics.com
  • URL: https://slimlytics.com/api/sites/{siteId}/icon
  • Auth: HTTP bearer

Path parameters

siteIdstring uuid required

Site UUID

Request body

mode'initials' | 'favicon' required

favicon fetches the site's icon now and fails with 400 if none can be loaded

backgroundstring nullable
backgroundEndstring nullable
foregroundstring nullable

Response

Updated site

idstring uuid required
namestring required
domainstring required
timezonestring required
allowedOriginsstring[] required
retentionDaysinteger required
writeKeystring uuid required

Collection-only key; not an account credential

serverWriteKeystring uuid required

Rotatable collection-only secret for trusted server request batches

proxyKeystring uuid required

Server-side secret sent by the site's first-party proxy as X-Slimlytics-Proxy-Key with X-Slimlytics-Client-IP so locations and visitor IDs use the real visitor IP. Keep it out of public repositories; rotate with POST /api/sites/{siteId}/rotate-proxy-key if exposed

antiAdblockServer'caddy' | 'nginx' | 'apache' required
antiAdblockJsPathstring required
antiAdblockBeaconPathstring required
iconMode'initials' | 'favicon' required

Dashboard avatar: initials on a colored tile, or the website's favicon

iconBackgroundstring nullable required

Tile gradient start; null uses an automatic per-domain hue

iconBackgroundEndstring nullable required

Tile gradient end; null keeps the background solid

iconForegroundstring nullable required

Initials color; null uses white

iconUpdatedAtstring date-time nullable required

When the stored favicon last changed; add it to the GET /api/sites/{siteId}/icon URL to bust caches

createdAtstring date-time required

Changes

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