Interest actions#

GA4 events that show someone chose to take an interest, such as joining a waitlist or viewing pricing, short of the success metric.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/interest-actions#

List the GA4 events the workspace tracks as interest actions: things a visitor chose to do on the site that are not yet the success metric, such as joining a waitlist, downloading a guide or viewing pricing.

bash

GET /v1/interest-actions?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

PUT /v1/interest-actions#

Update the full set of GA4 events tracked as interest actions. Events left out stop being tracked and their synced counts are removed. History for new events is backfilled automatically. The event that counts the success metric cannot also be an interest action.

Owner only

bash

PUT /v1/interest-actions
Authorization: Bearer {token}
Content-Type: application/json

{
  "workspace_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "actions": "..."
}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.
actions	`Array<object>`	Required	Every GA4 event to track as an interest action. Events left out stop being tracked and their synced counts are removed.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.