Skip to main content
GET
Returns retention save-offer views, accepts, declines, acceptance rates, and accepted-versus-declined revenue LTV where supported.
This endpoint requires a tenant-scoped API key and the retention-offer analytics capability for the tenant.

Response

LTV availability

Revenue LTV is currently available only for sonnys-shared tenants. Other providers return an explained null LTV block:
Use ltv.coverage to compare LTV sample size against totals.accepted and totals.declined. LTV is computed only for decision events that include a joinable customer id.

Dates

start and end accept date-only values or explicit timestamps. Date-only lower bounds start at 00:00:00.000Z; date-only upper bounds include the full UTC day. If you omit start, Nautilus queries all time. If you omit end, Nautilus uses the current time internally. Omitted bounds are returned as null in dateRange.

Errors

  • 400 - Retention offer analytics are not available for this organization.
  • 401 - Missing, invalid, or non-tenant-scoped API key.
  • 500 - Internal server error.

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Query Parameters

start
string

Inclusive lower bound on offer events. Date-only values start at 00:00:00.000Z.

end
string

Inclusive upper bound on offer events. Date-only values include the full UTC day.

Response

Retention offer analytics response

organizationId
string
required
dateRange
Date range · object
required
totals
object
required
offers
object[]
required
ltv
object
required