Status API › Analytics
Update analytics settings
PATCH/api/v1/pages/{pageID}/analytics/settings
Turns visitor analytics on or off, sets how long daily counts are kept, the
Google Analytics 4 id the public page loads ("" clears it) and whether
privacy signals are honoured. A field left out is unchanged.
Permission (API-key scope): status:page:write.
Authorization
bearerAuth(status:page:write)apiKeyHeader(status:page:write)
Parameters
Path parameters
pageIDstring (uuid) requiredThe status page's id (a UUID).
Request body required
enabledbooleanretention_daysintegerga4_measurement_idstringhonor_privacy_signalsboolean
Responses
200
The page.
dataPage requiredShow Page properties
idstring (uuid) requiredorg_idstring requiredteam_idstring requiredThe team that manages the page;""for the whole organization. Never affects the public page.slugstring requiredUnique in the organization.namestring requiredlogo_urlstringfavicon_urlstringbrand_colorstring#rrggbb.custom_domainstringis_publicboolean requiredWhether visitors can read it.themestring requiredsite_themeSiteTheme requiredShow SiteTheme properties
fontstring""is the system font.radiusstringbackgroundstringmodestringThe same setting as the page'stheme(systemthere isauto).
subscriptions_enabledbooleanreply_to_emailstringWhere replies to subscriber emails go.page_descriptionstringfooter_textstringsupport_urlstringsupport_labelstringprivacy_urlstringterms_urlstringga_tagstringThe older field for the Google Analytics id, kept in step withanalytics.ga4_measurement_id.search_indexablebooleanhistory_window_daysintegerHow far back the public page shows past incidents.product_groupsbooleanGroups fold into one line each on the public page.open_groupsarray of stringGroups that start open.product_pagesbooleanEach group has a page of its own.header_linksarray of HeaderLinkShow HeaderLink properties
labelstring requiredOne line of text.urlstring (uri) requiredAnhttps://URL.
show_page_namebooleanfalseshows the logo alone.analyticsAnalyticsSettingsShow AnalyticsSettings properties
enabledbooleanWhether visitor analytics are collected.retention_daysintegerHow long daily counts are kept.ga4_measurement_idstringA Google Analytics 4 id (G-…) the public page loads, or"".honor_privacy_signalsbooleanLoad Google Analytics only for visitors who sent neitherDNT: 1norSec-GPC: 1.
created_atstring (date-time) requiredupdated_atstring (date-time) required
successboolean required
400
A field is missing or invalid (VALIDATION_ERROR); the message names it, or the body is not valid (INVALID_BODY).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
404
No such item, or one the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
Example request
curl -X PATCH 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/analytics/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"enabled": true,
"retention_days": 365,
"ga4_measurement_id": "G-ABC123XYZ9"
}'