Skip to content

Commit 0a16f43

Browse files
committed
doc update
1 parent 38182ed commit 0a16f43

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

src/features/2.metrics.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ Metric is used to allow admin configuring custom metrics for an assessment to se
77
### `analytics_metrics`
88

99
* `id` id of this metric
10+
* `uuid` uuid of this metric
1011
* `name` the name of this metric
1112
* `description` the description of this metric
1213
* `is_public` whether this is a public metrics in the metrics library
1314
* `data_source` : which data source we are linking to for the calculation
14-
* For MVP, we only support `assessment question`
15+
* For MVP, we only support `question`
1516
* `data_type` defines how to link to an assessment question. It has the following valid value (MVP):
1617
* `scalar` : can only be linked to a radio button choice question of an assessment
1718
* `aggregation` defines how to calculate the result. It has the following valid value: (when the `data_type` is `scalar`)
@@ -36,9 +37,9 @@ Relationship between a metric and an institution
3637
* `recommanded` : an experience can go live without linking this metric to an assessment, but there will be a warning
3738
* `not required` : an experience can go live without linking this metric to an assessment
3839
* `status`
39-
* `draft` : won't show on the experience page
40-
* `active` : show on the experience page
41-
* `archived` : won't show on the experience page
40+
* `inactive` : when this metric is not linked to any assessment question in any experience
41+
* `active` : when the metric is linked to an assessment question in an experience
42+
* `archived` : the metric won't be calculated anymore
4243

4344
### `analytics_metric_links`
4445

@@ -47,7 +48,7 @@ Relationship between a metric and a data source link in an experience
4748
* `id`
4849
* `metric_id`
4950
* `data_source_id` : the related data source id
50-
* When `data_source` = `assessment question`, this id is the question id
51+
* When `data_source` = `question`, this id is the question id
5152
* `experience_id`
5253
* `institution_id`
5354
* `calculation_frequency` : when to calculate the metrics
@@ -67,9 +68,9 @@ The table to store the metric report records
6768

6869
### Create metric
6970

70-
There will be a page on the institution level to see all the required/recommanded metric and institution admin is able to create new metric or use a metric from the metric library.
71+
There will be a page on the institution level to see all the metrics in the institution and institution admin is able to create new metric or use a metric from the metric library.
7172

72-
### Use metric
73+
### Configure metric
7374

7475
On the experience dashboard, there will be a "metrics" tab. Admin can configure the metric (i.e. link metric to a specific assessment question).
7576

0 commit comments

Comments
 (0)