Skip to content

Commit fedab9a

Browse files
committed
update doc
1 parent 404d023 commit fedab9a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/features/2.metrics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Metric is used to allow admin configuring custom metrics for an assessment to se
1111
* `description` the description of this metric
1212
* `is_public` whether this is a public metrics in the metrics library
1313
* `data_source` : which data source we are linking to for the calculation
14-
* For MVP, we only support `question`
14+
* For MVP, we only support `assessment question`
1515
* `data_type` defines how to link to an assessment question. It has the following valid value (MVP):
1616
* `scalar` : can only be linked to a radio button choice question of an assessment
1717
* `aggregation` defines how to calculate the result. It has the following valid value: (when the `data_type` is `scalar`)
@@ -44,9 +44,9 @@ Relationship between a metric and an institution
4444
Relationship between a metric and a data source link in an experience
4545

4646
* `id`
47-
* `metrics_id`
47+
* `metric_id`
4848
* `data_source_id` : the related data source id
49-
* When `data_source` = `question`, this id is the question id
49+
* When `data_source` = `assessment question`, this id is the question id
5050
* `experience_id`
5151
* `institution_id`
5252
* `calculation_frequency` : when to calculate the metrics
@@ -57,7 +57,7 @@ Relationship between a metric and a data source link in an experience
5757
The table to store the metric report records
5858

5959
* `id`
60-
* `metrics_question_id`
60+
* `metric_link_id`
6161
* `value` : metric data value result
6262
* `count` : how many data have we gone through to do the calculation
6363
* `created` : date when the record gets calculated

0 commit comments

Comments
 (0)