SHshipsecai
analytics

PUT /api/v1/analytics/settings

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/analytics/settings
  • Auth
    none declared

Request body

analyticsRetentionDaysnumber

Data retention period in days (must be within tier limits)

subscriptionTier'free' | 'pro' | 'enterprise'

Subscription tier (optional - usually set by billing system)

Example request

{
  "analyticsRetentionDays": 30
}

Response

Update analytics settings for the authenticated organization

organizationIdstring required

Organization ID

subscriptionTier'free' | 'pro' | 'enterprise' required

Subscription tier

analyticsRetentionDaysnumber required

Data retention period in days

maxRetentionDaysnumber required

Maximum retention days allowed for this tier

createdAtstring date-time required

Timestamp when settings were created

updatedAtstring date-time required

Timestamp when settings were last updated

Example response

{
  "organizationId": "org_abc123",
  "subscriptionTier": "free",
  "analyticsRetentionDays": 30,
  "maxRetentionDays": 30,
  "createdAt": "2026-01-20T00:00:00.000Z",
  "updatedAt": "2026-01-20T00:00:00.000Z"
}

Changes