neet/masto.js

export type CohortFrequency = "day" | "month";

export interface CohortData {
  /** The timestamp for the start of the bucket, at midnight. */
  date: string;
  /** The percentage rate of users who registered in the specified `period` and were active for the given `date` bucket. */
  rate: number;
  /** How many users registered in the specified `period` and were active for the given `date` bucket. */
  value: number;
}

/**
 * Represents a retention metric.
 */
export interface Cohort {
  /** The timestamp for the start of the period, at midnight. */
  period: string;
  /** The size of the bucket for the returned data. */
  frequency: CohortFrequency;
  /** Retention data for users who registered during the given period. */
  data: CohortData[];
}