Check the tag now
Runs the tag check of the site now, as the Installation tab's Check now button does: AISA loads the site's homepage once, looks for the tag, records what it found, and opens or closes the site's alert as the hourly check would (an alert opens only for a site whose tag was seen before, and a confirmed miss emails the organization's admins). The answer is what this load found: `present`, `absent`, or `unverifiable` when the page could not be read, in which case nothing is decided and no alert changes. A site can be checked once a minute, counting the hourly check: a second request inside that minute is refused with `429` and a `Retry-After` header. A site with tag monitoring off, or with no address, is refused with `tag_check_unavailable`. It changes no setting, so it records no audit entry.
Authorization
ApiKeyAuth A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1/sites/string/tag-check"{ "data": { "siteId": "site_01kvnwmagvf27rc9cze5rm9e1r", "outcome": "absent", "alertOpen": true }}List a site's engagement exposure events over a period
Returns the raw funnel events the dashboard's Exposures tab lists, newest first: a widget shown, a launcher shown, a conversation opened, a starter question shown, the resume button. This is a debug-grade view of single events, not a metric: read the Engagement report for aggregates. A row carries an opaque session id and, when one exists, the conversation id. The page has no total. A cursor is bound to the period, the device and the type it was issued for. `from` and `to` are required UTC days, at most 366 days apart.
List alerts
Returns the organization's alerts, as the Alerts page of the dashboard lists them. With `state=open` (the default) they are ordered by severity, then the oldest first; with `state=resolved` they are the history, the most recently resolved first, bounded to the most recent 100. An alert is opened and closed by AISA, never by a caller. `tag_missing` opens when the tag that was seen on a site's homepage is no longer there, and closes when it is back or when tag monitoring is turned off for the site. `widget_mount_failed` (a `warning`) opens when an inline widget could not find its place on the page in too many sessions of its live version over the last 24 hours; it names the widget in `subject` and closes when the widget shows again, is switched off or is deleted. `experiment_guardrail_paused` (a `warning`) opens when a safety check pauses an A/B test, never when a member stops a test or switches off its widget; it names the test in `subject` and closes when a new test starts on the widget, when the widget is deleted, or 14 days after it opened. `orders_fall` and `orders_stopped` (both a `warning`) concern a site and have no `subject`. `orders_fall` opens when a complete UTC day's orders are under half the usual level for that weekday while order events still arrived that day; `orders_stopped` opens when no order event arrived for 24 hours on a site that usually receives several orders a day. Both stay silent until the site's first order is 8 weeks old, and both close with `orders_recovered` when orders are back. An orders alert carries no figure, and AISA cannot tell a broken checkout from a broken order feed. `widget_engagement_fall` (a `warning`) opens once a day when a widget's engagement rate over the last 7 complete days falls to half of its usual level, the median of the 3 weeks before, on a widget with at least 200 sessions that saw it in each week and no member change or test in those weeks; it names the widget in `subject` and closes when a later week's rate is back to the level it opened against, when the widget is switched off, or when it is deleted. Every open alert of a site closes with `site_deleted` when the site is deleted. `connector_unavailable` (a `critical`) opens when a connector that a live agent uses has failed two hourly checks in a row, which means the assistant answers without it; it names the connector in `subject` and closes at the first check that succeeds, when no live agent uses the connector any more, or when it is deleted. Check a connector now with `POST /api/v1/connectors/{connectorId}/check`. `quota_conversations`, `quota_page_reads` and `quota_generations` open as `warning` when that monthly quota reaches 80% and become `critical` when reaching the quota stops the service; they close when the quota is raised or a new month starts. A quota alert carries no site, no figure and no cost.