Service Design Specification - Object Design for adminAnalyticsReport
tutorhub-platformadmin-service documentation
Document Overview
This document outlines the object design for the adminAnalyticsReport model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
adminAnalyticsReport Data Object
Object Overview
Description: Stores generated analytics/reporting URLs/metadata for admin dashboard access. Reports are generated by backend tasks/edge (future), but listing is for download/view.
This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement.
It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.
Core Configuration
- Soft Delete: Enabled — Determines whether records are marked inactive (
isActive = false) instead of being physically deleted. - Public Access: accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules.
Properties Schema
| Property | Type | Required | Description |
|---|---|---|---|
reportType |
String | Yes | Type of the analytics report (enrollments, revenue, complaints, etc). |
filterParams |
String | No | Filter params as stringified JSON for reporting input. |
generatedAt |
Date | Yes | Date/time report was generated. |
reportUrl |
String | Yes | Accessible URL where generated report is stored (PDF, CSV, etc). |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.
Default Values
Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.
- reportType: ‘default’
- generatedAt: new Date()
- reportUrl: ‘default’
Constant Properties
reportType filterParams generatedAt reportUrl
Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle.
A property is set to be constant if the Allow Update option is set to false.
Elastic Search Indexing
reportType generatedAt
Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.
Database Indexing
reportType generatedAt
Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.