Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

Retention

Track how users progress, return and drop off over their lifetime.

Retention endpoints read each user's whole history, so the web app calls them without a date window. They share the Analytics filters and the same 429 retry behaviour.

Retrieve time to launch

Admin JWT internal
GET /admin/dashboard/time-to-launch

Returns how many users reached each launch-count milestone, by days since signup.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.
  • milestones string Optional
    Comma-separated launch counts, such as 1,5,10.
  • max_days integer Optional
    Days after signup to cover.

Returns 200 OK · application/json

  • max_days integer
    Days covered.
  • total_users integer
    Users counted.
  • active_users integer
    Users with at least one launch.
  • milestones array<object>
    One entry per milestone.
    Child attributes 3
    • milestone integer
      Launch count.
    • reached integer
      Users who ever reached it.
    • cumulative array<integer>
      Index is days after signup; value is users who had reached it by then.

Errors

StatusCodeWhen and what to do
400 bad_request milestones is not a comma-separated list of launch counts. More than 20 milestones answers at most 20 milestones. Send up to 20 comma-separated launch counts, such as 1,5,10.
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardTimeToLaunch(params) src/lib/proxima/endpoints/admin.ts

Retrieve churn

Admin JWT internal
GET /admin/dashboard/churn

Returns users grouped by days since their last launch.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.

Returns 200 OK · application/json

  • buckets array<object>
    Inactivity buckets.
    Child attributes 4
    • label string
      Bucket label.
    • min_days integer
      Lower bound, in days.
    • max_days integer | null
      Upper bound, in days. null for the last bucket.
    • user_count integer
      Users in the bucket.
  • currency enum
    Unit applied to the money amounts.
    Possible values usdnative

Errors

StatusCodeWhen and what to do
400 bad_request currency is not usd or native. Send currency=usd or currency=native.
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardChurn(params) src/lib/proxima/endpoints/admin.ts

List churned users

Admin JWT internal
GET /admin/dashboard/churn/users

Returns the users in an inactivity range, with their last launch.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.
  • min_days integer Required
    Minimum days since the last launch.
  • max_days integer Optional
    Maximum days since the last launch.
  • limit integer Optional
    Page size.
  • offset integer Optional
    Number of rows to skip.
  • sort enum Optional
    Sort key.
    Possible values usernameinactivelaunchesrevenuepnl
  • order enum Optional
    Sort direction. desc is biggest first.
    Possible values ascdesc

Returns 200 OK · application/json

  • users array<object>
    Users.
    Child attributes 7
    • license_key string
      License key.
    • username string
      Username.
    • days_since_last_launch integer
      Days since the last launch.
    • total_launches integer
      Lifetime launches.
    • total_revenue_gross string
      Lifetime fees paid, in the requested currency (micro-USD, or lamports or wei), as an integer string.
    • total_pnl string
      Lifetime launch P&L, in the requested currency (micro-USD, or lamports or wei), as an integer string.
    • last_launch object
      Last launch: name, symbol, image_url, launched_at (Unix seconds), revenue_gross, pnl.
  • total integer
    Total matching users.
  • limit integer
    Applied page size.
  • offset integer
    Applied offset.
  • currency enum
    Unit applied to the money amounts.
    Possible values usdnative

Errors

StatusCodeWhen and what to do
400 bad_request currency is not usd or native. Send currency=usd or currency=native.
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardChurnUsers(params) src/lib/proxima/endpoints/admin.ts

Retrieve signup cohorts

Admin JWT internal
GET /admin/dashboard/cohorts

Returns retention per monthly signup cohort.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.
  • hide_inactive boolean Optional
    Leaves out users who never launched.

Returns 200 OK · application/json

  • windows array<object>
    Retention windows: label, start_days, end_days (days after signup).
  • cohorts array<object>
    One entry per signup month.
    Child attributes 4
    • cohort string
      Signup month, YYYY-MM (UTC).
    • start_at integer
      Month start, Unix seconds.
    • user_count integer
      Users in the cohort.
    • retention array<object>
      Per window, in the order of windows: eligible, active.

Errors

StatusCodeWhen and what to do
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardCohorts(params) src/lib/proxima/endpoints/admin.ts

List a cohort's users

Admin JWT internal
GET /admin/dashboard/cohorts/users

Returns the users of one signup cohort with their launches per window.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.
  • hide_inactive boolean Optional
    Leaves out users who never launched.
  • cohort string Required
    Signup month, YYYY-MM.
  • limit integer Optional
    Page size. The web app asks for 2000.
  • offset integer Optional
    Number of rows to skip.

Returns 200 OK · application/json

  • windows array<object>
    Retention windows: label, start_days, end_days (days after signup).
  • users array<object>
    Users.
    Child attributes 6
    • license_key string
      License key.
    • username string
      Username.
    • created_at integer
      Signup time, Unix seconds.
    • total_launches integer
      Lifetime launches.
    • last_launch_at integer | null
      Last launch time, Unix seconds.
    • launches array<integer>
      Launches per window, in the order of windows.
  • total integer
    Total users in the cohort.
  • limit integer
    Applied page size.
  • offset integer
    Applied offset.

Errors

StatusCodeWhen and what to do
400 bad_request cohort is not a month in YYYY-MM form. Send cohort as YYYY-MM, such as 2026-09.
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardCohortUsers(params) src/lib/proxima/endpoints/admin.ts

Retrieve stickiness

Admin JWT internal
GET /admin/dashboard/stickiness

Returns active users per short period against active users per longer period.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

For example numerator=day and denominator=month gives daily over monthly active users.

Query parameters

  • chain_id enum Optional
    Restricts to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • currency enum Optional Default usd
    Unit of the money amounts. The web app offers native only with a chain_id.
    Possible values usdnative
  • include_archived boolean Optional Default true
    Counts archived launches.
  • count_group_members boolean Optional Default false
    Counts launches that belong to a launch group.
  • utc_offset integer Optional
    Offset from UTC, in hours, for bucket boundaries. The web app leaves it out for UTC+1.
  • numerator enum Optional
    Short period.
    Possible values dayweekmonthyearall
  • denominator enum Optional
    Long period.
    Possible values dayweekmonthyearall

Returns 200 OK · application/json

  • numerator enum
    Short period applied.
    Possible values dayweekmonthyearall
  • denominator enum
    Long period applied.
    Possible values dayweekmonthyearall
  • points array<object>
    One point per short period.
    Child attributes 4
    • period_start integer
      Short period start, Unix seconds.
    • active_users integer
      Users with a launch in the short period.
    • denominator_period_start integer
      Enclosing long period start, Unix seconds.
    • denominator_active_users integer
      Users with a launch in the long period.

Errors

StatusCodeWhen and what to do
400 bad_request numerator or denominator is not a known period. Send day, week, month, year or all.
429 too_many_requests All analytics slots stayed busy for 45 seconds: the API runs at most three analytics computations at once. The web app retries with exponential backoff (2 s doubling, capped at 30 s, up to 8 retries). Retry with exponential backoff.
429 too_many_requests The aggregate ran past the 60-second analytics limit and was stopped. The API serves its last answer for the same query instead when it has one from the past hour, so this means it has none. Retry with exponential backoff, and narrow the query, for example to one chain_id, if it keeps failing.

Also the common errors: 401 for a missing or expired session, 403 forbidden without the admin role and 429 when rate limited.

Web client proxima.admin.getDashboardStickiness(params) src/lib/proxima/endpoints/admin.ts