分析工具¶
分析工具¶
要访问 DHIS2 中的分析汇总数据,您可以使用 *分析*资源。分析资源非常强大,因为它可以让您 查询和检索沿所有可用数据维度聚合的数据。 例如,您可以要求分析资源提供 一组数据元素、时间段和 组织单位。此外,您可以检索聚合数据 基于数据元素的任意数量维度的组合和 组织单位组集。
Table: Data query parameters
请求查询参数¶
分析资源可让您指定一系列查询参数:
选项值
| 查询参数 | 需要 | 描述 | 选项(默认为默认) |
|---|---|---|---|
| 维度 | 是的 | width | /api/visualizations/R0DVGvXDUNP/data |
| /api/visualizations/R0DVGvXDUNP/data?date=2013-06-01 |
/api/visualizations/jIISuEWxmoI/data.html
/api/visualizations/jIISuEWxmoI/data.html?date=2013-01-01
/api/visualizations/FPmvWs7bn2P/data.xls
/api/visualizations/FPmvWs7bn2P/data.pdf
/api/eventVisualizations/x5FVFVt5CDI/data
/api/eventVisualizations/x5FVFVt5CDI/data.png
/api/maps/DHE98Gsynpr/data
/api/maps/DHE98Gsynpr/data?date=2013-07-01
/api/reports/OeJsA6K1Otx/data.pdf
/api/reports/OeJsA6K1Otx/data.pdf?date=2014-01-01 |
| 数据值 | 不 | 用于检索各种分析的有效 URL 的一些示例 代表如下。 | /api/visualizations/R0DVGvXDUNP/data /api/visualizations/R0DVGvXDUNP/data?date=2013-06-01
/api/visualizations/jIISuEWxmoI/data.html
/api/visualizations/jIISuEWxmoI/data.html?date=2013-01-01
/api/visualizations/FPmvWs7bn2P/data.xls
/api/visualizations/FPmvWs7bn2P/data.pdf
/api/eventVisualizations/x5FVFVt5CDI/data
/api/eventVisualizations/x5FVFVt5CDI/data.png
/api/maps/DHE98Gsynpr/data
/api/maps/DHE98Gsynpr/data?date=2013-07-01
/api/reports/OeJsA6K1Otx/data.pdf
/api/reports/OeJsA6K1Otx/data.pdf?date=2014-01-01 |
| Events resource only. Custom period on scheduledDate. See "custom date periods" section. | 不 | 要访问 DHIS2 中的分析汇总数据,您可以使用 *分析*资源。分析资源非常强大,因为它可以让您 查询和检索沿所有可用数据维度聚合的数据。 例如,您可以要求分析资源提供 一组数据元素、时间段和 组织单位。此外,您可以检索聚合数据 基于数据元素的任意数量维度的组合和 组织单位组集。 | no | | 请求查询参数 { #webapi_analytics_query_parameters } | 不 | Table: Query parameters | 查询参数 | | 需要 | 不 | 选项(默认为默认) | 查询参数 | | 开始日期 | 不 | Any dimension | 日期 | | 结束日期 | 不 | Any dimension | 日期 | | 不 | 不 | SUM | AVERAGE | AVERAGE_SUM_ORG_UNIT | LAST | LAST_AVERAGE_ORG_UNIT | COUNT | STDDEV | VARIANCE | MIN | MAX | 假 | | 不 | 不 | ASC | DESC | 假 | | sortOrder | 不 | EQ | GT | GE | LT | LE | 假 | | stage | 不 | Program stage identifier. | 假 | | 不 | 不 | 忽略响应中最多 50 000 条记录的限制--谨慎使用。 | 假 | | 不 | 不 | false | true | 假 | | 不 | 不 | false | true | 假 | | The program stage associated. | 不 | false | true | 假 | | Custom period on incidentDate. See "custom date periods" section. | 不 | lastUpdated | 假 | | 不 | 不 | false | true | 假 | | 不 | 不 | ouname | programstatus | createdbydisplayname | lastupdatedbydisplayname | enrollmentdate | incidentdate | lastupdated | <dimension identifier> | 假 | | Custom period on lastUpdated. See "custom date periods" section. | 不 | DESCENDANTS, CHILDREN, SELECTED | 查询参数 | | json { "httpStatus": "OK", "httpStatusCode": 200, "status": "OK", "response": { "responseType": "ObjectReport", "uid": "pG4bBTMiCqO", "klass": "org.hisp.dhis.dataexchange.aggregate.AggregateDataExchange", "errorReports": [] } } | 不 | false | true | page | | Required / Notes | 不 | 查询响应中元数据项使用的标识符方案。该参数覆盖了专门用于机关单位的 "outputIdScheme"。它可接受标识符、代码或属性。 | includeNumDen | | 是的 | 不 | 查询响应中元数据项使用的标识符方案。该参数专门用于覆盖数据元素的 "outputIdScheme"。它可接受标识符、代码或属性。 | includeNumDen | | The name of the headers to be returned as part of the response. One or more headers name separated by comma | 不 | 不 | displayProperty | | 不 | 不 | NAME | SHORTNAME | outputIdScheme | | 描述 | 不 | 需要 | 日期 | | 不 | 不 | UUID | CODE | NAME | ATTRIBUTE:<ID> | 组织单位标识符。 | | 列 | 不 | 维度标识符包括数据元素、属性、期间、组织单位和组织单位组集。参数可以重复任意次数。项目过滤器可以应用于维度,格式为<item-id>:<operator>:<filter>。过滤器值不区分大小写。 | hierarchyMeta | | 不 | 不 | false | true | hierarchyMeta | | iasc 和 idesc 是不区分大小写的排序。如果需要对多个属性进行排序,请使用逗号将它们分开。 | 不 | Identifier of approval level | 价值 | | 不 | 不 | 日期 | EVENT_DATE | ENROLLMENT_DATE | INCIDENT_DATE | DUE_DATE | COMPLETED_DATE | CREATED | LAST_UPDATED | <Attribute ID> | <Data element ID> | | 事件聚合资源不返回事件信息 本身,而不是与请求匹配的事件总数 询问。事件维度包括数据元素、人员属性、人员 标识符、期间和组织单位。聚合事件查询 应该是下面描述的格式。 | 不 | false | true | skipMeta | | 不 | 不 | 启用尺寸/筛选器的增强条件 | 假 |
dimension 查询参数定义了哪些维度应该是 包含在分析查询中。可以是任意数量的维度 指定的。每个维度都应该重复维度参数 包含在查询响应中。查询响应可能 包含指定的所有组合的聚合值 维度项。
filter 参数定义应将哪些维度用作 在分析查询中检索到的数据的过滤器。任意数量 可以指定过滤器。过滤器参数应该重复 要在查询中使用的每个过滤器。过滤器与维度的不同之处在于 过滤器维度不会成为查询响应的一部分 内容,并且响应中的聚合值将是 在过滤器尺寸上折叠。换句话说,数据在 响应将在过滤器维度上聚合,但过滤器 不会作为维度包含在实际响应中。作为 例如,查询按句点过滤的某些数据元素和 您可以使用以下 URL 的组织单位:
Any dimension (must be query dimension)
aggregationType 查询参数允许您定义哪个聚合 运算符应该用于查询。默认情况下,聚合 将使用为查询中包含的数据元素定义的运算符。 如果您的查询不包含任何数据元素但包含数据 元素组,第一个数据元素的聚合运算符 将使用第一组。组和数据元素的顺序是 不明确的。此查询参数允许您覆盖默认值和 指定特定的聚合运算符。例如,您可以设置 使用以下 URL 进行“计数”的聚合运算符:
不
measureCriteria 查询参数可让您过滤掉数据范围 要返回的记录。您可以指示系统仅返回记录 其中聚合数据值等于、大于、大于或 等于、小于或小于或等于某些值。您可以指定任何 以下格式的标准数量,其中 criteria 和 value 应替换为实际值:
ASC | DESC
例如,以下查询将仅返回以下记录 数据值大于或等于 6500 且小于 33000:
不
类似于 measureCriteria,preAggregationMeasureCriteria 查询 参数让你过滤掉数据,只有在聚合之前 执行。例如,以下查询仅聚合数据,其中 原始值在定义的标准内:
EVENT_DATE | ENROLLMENT_DATE | INCIDENT_DATE | DUE_DATE | COMPLETED_DATE | CREATED | LAST_UPDATED | <Attribute ID> | <Data element ID>
startDate 和 endDate 参数可用于指定自定义 要汇总的日期范围。指定日期范围时,您不能 将相对或固定期间指定为维度或过滤器。日期范围 将过滤分析响应。你可以这样使用它:
不
为了让分析资源生成形状中的数据 一个现成的表格,你可以提供 tableLayout 参数 true 作为值。而不是生成一个普通的、规范化的数据源, 分析资源现在将生成表格布局中的数据。你 可以将 columns 和 rows 参数与维度标识符一起使用 用分号分隔作为值以指示使用哪些值 表格列和行。列和行维度必须存在 作为查询中的数据维度(不是过滤器)。这样的请求可以看 像这样:
<Attribute ID> | <Data element ID> | REGISTRATION | ENROLLMENT | OWNER_AT_START | OWNER_AT_END
在 表格布局中可请求的列和行组合数量受 keyAnalyticsDownloadCombinationLimit 系统设置的限制,其默认值为 20000。该限制分别 适用于列组合和行组合,而不适用于两者的 乘积。 超过此限制的请求将返回错误代码 E7151。
enhancedConditions
不
Enable enhanced conditions for dimensions and filters.¶
false | true
dimension 查询参数定义了哪些维度应该是 包含在分析查询中。可以是任意数量的维度 指定的。每个维度都应该重复维度参数 包含在查询响应中。查询响应可能 包含指定的所有组合的聚合值 维度项。
| /api/analytics/enrollments/query/WSGAb5XwJ3Y.xls ?dimension=ou:ImspTQPwCqd &dimension=WZbXY0S00lP.de0FEHSIoxh &columns=w75KJ2mc4zz &dimension=WZbXY0S00lP.sWoqcoByYmD &dimension=pe:LAST_MONTH &stage=WZbXY0S00lP &pageSize=10&page=1 &asc=ENROLLMENTDATE &ouMode=DESCENDANTS | 值不引用数字元素或项目一部分的数据元素或属性 | aggregationType 查询参数允许您定义哪个聚合 运算符应该用于查询。默认情况下,聚合 将使用为查询中包含的数据元素定义的运算符。 如果您的查询不包含任何数据元素但包含数据 元素组,第一个数据元素的聚合运算符 将使用第一组。组和数据元素的顺序是 不明确的。此查询参数允许您覆盖默认值和 指定特定的聚合运算符。例如,您可以设置 使用以下 URL 进行“计数”的聚合运算符: | |---|---|---| | /api/analytics?dimension=dx:fbfJHSPpUQD&dimension=pe:2014Q1&dimension=ou:O6uvpzGd5pu &aggregationType=COUNT | measureCriteria 查询参数可让您过滤掉数据范围 要返回的记录。您可以指示系统仅返回记录 其中聚合数据值等于、大于、大于或 等于、小于或小于或等于某些值。您可以指定任何 以下格式的标准数量,其中 criteria 和 value 应替换为实际值: | /api/analytics?measureCriteria=criteria:value;criteria:value | | 例如,以下查询将仅返回以下记录 数据值大于或等于 6500 且小于 33000: | E7228 | Fallback coordinate field is invalid | | /api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:2014 &dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw&preAggregationMeasureCriteria=GE:10;LT:100 | Filter on whether the current user can manage the returned users through the managed user group relationships. | /api/analytics.json?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU &dimension=ou:ImspTQPwCqd&startDate=2018-01-01&endDate=2018-06-01 | | 为了让分析资源生成形状中的数据 一个现成的表格,你可以提供 tableLayout 参数 true 作为值。而不是生成一个普通的、规范化的数据源, 分析资源现在将生成表格布局中的数据。你 可以将 columns 和 rows 参数与维度标识符一起使用 用分号分隔作为值以指示使用哪些值 表格列和行。列和行维度必须存在 作为查询中的数据维度(不是过滤器)。这样的请求可以看 像这样: | 描述 | order 参数可用于分析资源生成 有序数据。数据将按升序(或降序)排序 值。以降序对值进行排序的示例请求 顺序是: | | /api/analytics?dimension=dx:fbfJHSPpUQD&dimension=pe:LAST_12_MONTHS &dimension=ou:O6uvpzGd5pu&order=DESC | 尺寸和项目 { #webapi_analytics_dimensions_and_items } | DHIS2 features a multi-dimensional data model with several fixed and dynamic data dimensions. The fixed dimensions are the data element, period (time) and organisation unit dimension. You can dynamically add dimensions through categories, category option group sets, organisation unit group sets, data element group sets and organisation unit group sets. The table below displays the available data dimensions in DHIS2. Each data dimension has a corresponding dimension identifier, and each dimension can have a set of dimension items: | | Table: Dimensions and dimension items | 尺寸 | Dimension id | | Dimension items | Data elements, indicators, data set reporting rate metrics, data element operands, program indicators, program data elements, program attributes, validation rules | dx | | /api/analytics/events | Data elements, indicators, data set reporting rate metrics, data element operands, program indicators, program data elements, program attributes, validation rules | 聚乙烯 | | ISO periods and relative periods, see "date and period format" | Data elements, indicators, data set reporting rate metrics, data element operands, program indicators, program data elements, program attributes, validation rules | 欧 |
Organisation unit identifiers, and keywords USER_ORGUNIT, USER_ORGUNIT_CHILDREN, USER_ORGUNIT_GRANDCHILDREN, LEVEL-<level> and OU_GROUP-<group-id>
Category option combinations
co
Category option combo identifiers (omit to get all items)
Attribute option combinations
ao
在上例中,客户端将收到所有配置为 数据维度 且(通过数据集和类别组合)与数据元素 fbfJHSPpUQD 相关联的 类别。 此外,所有配置为 数据维度 的 组织单位组集 也会(且始终)作为响应的一部分被返回。
分类目录
<category id>
Category option identifiers (omit to get all items)
数据元素组集
{
"headers": [
{
"name": "dx",
"column": "Data",
"meta": true,
"type": "java.lang.String"
},
{
"name": "pe",
"column": "Period",
"meta": true,
"type": "java.lang.String"
},
{
"name": "value",
"column": "Value",
"meta": false,
"type": "java.lang.Double"
}
],
"height": 4,
"metaData": {
"pe": [
"2016Q1",
"2016Q2"
],
"ou": [
"ImspTQPwCqd"
],
"names": {
"2016Q1": "Jan to Mar 2016",
"2016Q2": "Apr to Jun 2016",
"FbKK4ofIv5R": "Measles Coverage <1 y",
"ImspTQPwCqd": "Sierra Leone",
"eTDtyyaSA7f": "Fully Immunized Coverage"
}
},
"rows": [
[
"eTDtyyaSA7f",
"2016Q2",
"81.1"
],
[
"eTDtyyaSA7f",
"2016Q1",
"74.7"
],
[
"FbKK4ofIv5R",
"2016Q2",
"88.9"
],
[
"FbKK4ofIv5R",
"2016Q1",
"84.0"
]
],
"width": 3
}
{
"headers": [
{
"name": "psi",
"column": "Event",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ps",
"column": "节目阶段",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "eventdate",
"column": "活动日期",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "storedby",
"column": "存储人",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "lastupdated",
"column": "最后更新",
"valueType": "DATE",
"type": "java.time.LocalDate",
"hidden": false,
"meta": true
},
{
"name": "createdbydisplayname",
"column": "创建者(显示名称)",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "lastupdatedbydisplayname",
"column": "最后由(显示名称)更新",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "coordinates",
"column": "坐标",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ouname",
"column": "组织单位名称",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "oucode",
"column": "组织单位代码",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ou",
"column": "组织单位",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "oZg33kd9taw",
"column": "性别",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "qrur9Dvnyt5",
"column": "年龄",
"type": "java.lang.String",
"hidden": false,
"meta": false
}
],
"元数据": {
"名称": {
"qrur9Dvnyt5": "年龄",
"eBAyeGv0exc": "住院患者发病率和死亡率",
"ImspTQPwCqd": "塞拉利昂",
"O6uvpzGd5pu": "博",
"YuQRtpLP10I": "巴吉亚",
"oZg33kd9taw": "性别"
},
"ouHierarchy": {
"YuQRtpLP10I": "/ImspTQPwCqd/O6uvpzGd5pu"
}
},
"width": 8,
"height": 4,
"rows": [
[
"yx9IDINf82o",
"Zj7UnCAulEk",
"2016-08-05",
"system",
"2018-08-07",
"[5.12, 1.23]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"女性",
"50"
],
[
"IPNa7AsCyFt",
"Zj7UnCAulEk",
"2016-06-12",
"系统",
"2018-08-07",
"[5.22, 1.43]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"女性",
"50"
],
[
"ZY9JL9dkhD2",
"Zj7UnCAulEk",
"2016-06-15",
"system",
"2018-08-07",
"[5.42, 1.33]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"女性",
"50"
],
[
"MYvh4WAUdWt",
"Zj7UnCAulEk",
"2016-06-16",
"system",
"2018-08-07",
"[5.32, 1.53]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"女性",
"50"
]
]
}
{
"headers": [
{
"name": "psi",
"column": "Event",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "ps",
"column": "Program stage",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "eventdate",
"column": "Event date",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "storedby",
"column": "Stored by",
"valueType": "TEXT",
"hidden": false,
"meta": true
},
{
"name": "lastupdated",
"column": "Last Updated",
"valueType": "DATE",
"hidden": false,
"meta": true
},
{
"name": "createdbydisplayname",
"column": "Created by (display name)",
"valueType": "TEXT",
"hidden": false,
"meta": true
},
{
"name": "lastupdatedbydisplayname",
"column": "Last updated by (display name)",
"valueType": "TEXT",
"hidden": false,
"meta": true
},
{
"name": "coordinates",
"column": "Coordinates",
"valueType": "COORDINATE",
"hidden": false,
"meta": false
},
{
"name": "ouname",
"column": "Organisation unit name",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "oucode",
"column": "Organisation unit code",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "ou",
"column": "Organisation unit",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "oZg33kd9taw",
"column": "Gender",
"valueType": "TEXT",
"hidden": false,
"meta": false
},
{
"name": "qrur9Dvnyt5",
"column": "Age",
"valueType": "TEXT",
"hidden": false,
"meta": false
}
],
"metaData": {
"names": {
"qrur9Dvnyt5": "Age",
"eBAyeGv0exc": "Inpatient morbidity and mortality",
"ImspTQPwCqd": "Sierra Leone",
"O6uvpzGd5pu": "Bo",
"YuQRtpLP10I": "Badjia",
"oZg33kd9taw": "Gender"
},
"ouHierarchy": {
"YuQRtpLP10I": "/ImspTQPwCqd/O6uvpzGd5pu"
}
},
"width": 8,
"height": 4,
"rows": [
[
"yx9IDINf82o",
"Zj7UnCAulEk",
"2016-08-05",
"system",
"2018-08-07",
"[5.12, 1.23]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"Female",
"50"
],
[
"IPNa7AsCyFt",
"Zj7UnCAulEk",
"2016-06-12",
"system",
"2018-08-07",
"[5.22, 1.43]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"Female",
"50"
],
[
"ZY9JL9dkhD2",
"Zj7UnCAulEk",
"2016-06-15",
"system",
"2018-08-07",
"[5.42, 1.33]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"Female",
"50"
],
[
"MYvh4WAUdWt",
"Zj7UnCAulEk",
"2016-06-16",
"system",
"2018-08-07",
"[5.32, 1.53]",
"Ngelehun",
"OU_559",
"YuQRtpLP10I",
"Female",
"50"
]
]
}
{
"headers": [
{
"name": "oZg33kd9taw",
"column": "Gender",
"type": "java.lang.String",
"meta": false
},
{
"name": "qrur9Dvnyt5",
"column": "Age",
"type": "java.lang.String",
"meta": false
},
{
"name": "pe",
"column": "Period",
"type": "java.lang.String",
"meta": false
},
{
"name": "ou",
"column": "Organisation unit",
"type": "java.lang.String",
"meta": false
},
{
"name": "value",
"column": "Value",
"type": "java.lang.String",
"meta": false
}
],
"metaData": {
"names": {
"eBAyeGv0exc": "Inpatient morbidity and mortality"
}
},
"width": 5,
"height": 39,
"rows": [
[
"Female",
"95",
"201605",
"O6uvpzGd5pu",
"2"
],
[
"Female",
"63",
"201605",
"O6uvpzGd5pu",
"2"
],
[
"Female",
"67",
"201605",
"O6uvpzGd5pu",
"1"
],
[
"Female",
"71",
"201605",
"O6uvpzGd5pu",
"1"
],
[
"Female",
"75",
"201605",
"O6uvpzGd5pu",
"14"
],
[
"Female",
"73",
"201605",
"O6uvpzGd5pu",
"5"
]
]
}
{
"headers": [
{
"name": "count",
"column": "Count",
"type": "java.lang.Long",
"meta": false
},
{
"name": "center",
"column": "Center",
"type": "java.lang.String",
"meta": false
},
{
"name": "extent",
"column": "Extent",
"type": "java.lang.String",
"meta": false
},
{
"name": "points",
"column": "Points",
"type": "java.lang.String",
"meta": false
}
],
"width": 3,
"height": 4,
"rows": [
[
"3",
"POINT(-13.15818 8.47567)",
"BOX(-13.26821 8.4St7215,-13.08711 8.47807)",
""
],
[
"9",
"POINT(-13.11184 8.66424)",
"BOX(-13.24982 8.51961,-13.05816 8.87696)",
""
],
[
"1",
"POINT(-12.46144 7.50597)",
"BOX(-12.46144 7.50597,-12.46144 7.50597)",
""
],
[
"7",
"POINT(-12.47964 8.21533)",
"BOX(-12.91769 7.66775,-12.21011 8.49713)",
""
]
]
}
{
extent: "BOX(-13.2682125910096 7.38679562779441,-10.4261178860988 9.90401290212795)",
count: 59
}
{
"headers": [
{
"name": "pi",
"column": "Enrollment",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "tei",
"column": "被追踪的实体实例",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "enrollmentdate",
"column": "注册日期",
"valueType": "DATE",
"type": "java.util.Date",
"hidden": false,
"meta": true
},
{
"name": "incidentdate",
"column": "事件日期",
"valueType": "DATE",
"type": "java.util.Date",
"hidden": false,
"meta": true
},
{
"name": "storedby",
"column": "存储人",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "lastupdated",
"column": "最后更新时间",
"valueType": "DATE",
"type": "java.time.LocalDate",
"hidden": false,
"meta": true
},
{
"name": "storedby",
"column": "存储者",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "createdbydisplayname",
"column": "创建者(显示名称)",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "lastupdatedbydisplayname",
"column": "最后由(显示名称)更新",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "geometry",
"column": "几何",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "longitude",
"column": "Longitude",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": true
},
{
"name": "latitude",
"column": "纬度",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": true
},
{
"name": "ouname",
"column": "组织单位名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "oucode",
"column": "组织单位代码",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "oucode",
"column": "组织单位代码",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "de0FEHSIoxh",
"column": "WHOMCH 慢性病",
"valueType": "BOOLEAN",
"type": "java.lang.Boolean",
"hidden": false,
"meta": true
},
{
"name": "sWoqcoByYmD",
"column": "WHOMCH 吸烟",
"valueType": "BOOLEAN",
"type": "java.lang.Boolean",
"hidden": false,
"meta": true
}
],
"元数据": {
"分页": {
"页码": 2,
"总条目数": 163,
"每页条目数": 4,
"每页显示条目数": 41
},
"items": {
"ImspTQPwCqd": {
"name": "塞拉利昂"
},
"PFDfvmGpsR3": {
"name": "分娩护理"
},
"bbKtnxRZKEP": {
"name": "产后随访"
},
"ou": {
"name": "组织单位"
},
"PUZaKR0Jh2k": {
"name": "既往分娩史"
},
"edqlbukwRfQ": {
"name": "产前检查"
},
"WZbXY0S00lP": {
"name": "首次产前检查"
},
"sWoqcoByYmD": {
"name": "世卫组织母婴与儿童健康(WHOMCH)吸烟情况"
},
"WSGAb5XwJ3Y": {
"name": "世卫组织 RMNCH 追踪器"
},
"de0FEHSIoxh": {
"name": "世卫组织 MCH 慢性病"
}
},
"dimensions": {
"pe": [],
"ou": [
"ImspTQPwCqd"
],
"sWoqcoByYmD": [],
"de0FEHSIoxh": []
}
},
"width": 12,
"rows": [
[
"A0cP533hIQv",
"to8G9jAprnx",
"2019-02-02 12:05:00.0",
"2019-02-02 12:05:00.0",
"system",
"2020-08-06 21:20:52.0",
"",
"0.0",
"0.0",
"Tonkomba MCHP",
"OU_193264",
"xIMxph4NMP1",
"0",
"1"
],
[
"ZqiUn2uXmBi",
"SJtv0WzoYki",
"2019-02-02 12:05:00.0",
"2019-02-02 12:05:00.0",
"系统",
"2020-08-06 21:20:52.0",
"",
"0.0",
"0.0",
"Mawoma MCHP",
"OU_254973",
"Srnpwq8jKbp",
"0",
"0"
],
[
"lE747mUAtbz",
"PGzTv2A1xzn",
"2019-02-02 12:05:00.0",
"2019-02-02 12:05:00.0",
"system",
"2020-08-06 21:20:52.0",
"",
"0.0",
"0.0",
"Kunsho CHP",
"OU_193254",
"tdhB1JXYBx2",
"",
"0"
],
[
"nmcqu9QF8ow",
"pav3tGLjYuq",
"2019-02-03 12:05:00.0",
"2019-02-03 12:05:00.0",
"system",
"2020-08-06 21:20:52.0",
"",
"0.0",
"0.0",
"Korbu MCHP",
"OU_678893",
"m73lWmo5BDG",
"",
"1"
]
],
"height": 4
}
`filter=field:OP:value&filter=field:OP:value&...` | See [dimension filters section].(#webapi_analytics_dimension_filters) | #### fields no Allows field filtering - page - no - Page number - Defaults to 1 (first page) - pageSize - no - Page size - Defaults to 50 elements per page - paging - no - Disables pagination when `false` - `true` or `false`, defaults to `true` order - no - Allows sorting on the format: `order=field:direction` - Sortable fields: `created` (default), `lastUpdated`, `code`, `uid`, `id`, `name`, `displayName`, `dimensionType`
Direction can be `ASC` (default) or `DESC` - Dimension filters { #webapi_analytics_dimension_filters } - Dimensions endpoints support filtering the output to narrow down the response to desired elements. Filters are in the format `filter=field:op:value&filter=field:op:value&...&filter=field:op:value`. - Supported `field` values are: - **id**/**uid** - dimension id - **code** - dimension code - **valueType** - dimension value type - **name** - the name of the dimension - **dimensionType** - the type of the dimension ### 事件分析维度{ #event-analytics-dimensions } #### `PROGRAM_INDICATOR` `PROGRAM_ATTRIBUTE` - `CATEGORY` - `CATEGORY_OPTION_GROUP_SET` - **displayName** - displayName of the dimension **displayShortName** - displayShortName of the dimension - Supported `op`values are: - `startsWith` - field starts with - `!startsWith` - field does not start with `endsWith` - field ends with - `!endsWith` - field does not end with- - `eq` - equals - `ieq` - equals ignoring case - `ne` - not equals - `like` - contains 除 `IMAGE`、`FILE_RESOURCE` 和 `TRACKER_ASSOCIATE` 之外,数据元素和受追踪实体属性的所有值类型均被视为 *受支持的类型*。 #### `ilike` - contains ignoring case `!ilike` - does not contain ignoring case - `eq` - equals - `ieq` - equals ignoring case - `ne` - not equals - a tracker `program` `UNIT_INTERVAL` - both `program` and `programStage` - `INTEGER` - If only `program` is specified, the resource returns data dimensions for each program stage in the provided program - If only `programStage` is specified, the resource returns data dimensions for the provided `programStage` - If both `program` and `programStage` are specified, the resource returns data dimensions for the provided `programStage` if it belongs to the provided `program`. Returns an error otherwise. - the returned data dimensions are: - **Program indicators** associated with the program (derived from programStageId) - Enrollment analytics dimensions - **Tracked entity attributes** of *supported types* associated with the program (derived from programStageId) ### 招生分析维度{ #enrollment-analytics-dimensions } #### **Category option group sets** of type `ATTRIBUTE` All value types for data elements and tracked entity attributes are considered *supported types*, except `IMAGE` and `FILE_RESOURCE`. - Event aggregate dimensions { #webapi_event_aggregate_analytics_dimension } - Data elements and tracked entity attributes are considered *supported types* if their value type is one of the following: - **Data elements** of *supported types* in the program stage 除 `IMAGE`、`FILE_RESOURCE` 和 `TRACKER_ASSOCIATE` 之外,所有数据元素和受追踪实体属性的值类型均被视为 *受支持的类型*。 #### 与项目相关联的类别组合中的**类别**(源自项目阶段 ID) **Category option group sets** of type `ATTRIBUTE` associated with program (derived from programStageId) - Data elements and tracked entity attributes are considered *supported types* if their value type is one of the following: - **Data elements** of *supported types* in the program stage `UNIT_INTERVAL` - both `program` and `programStage` - `INTEGER` - If only `program` is specified, the resource returns data dimensions for each program stage in the provided program - If only `programStage` is specified, the resource returns data dimensions for the provided `programStage` - If both `program` and `programStage` are specified, the resource returns data dimensions for the provided `programStage` if it belongs to the provided `program`. Returns an error otherwise. - the returned data dimensions are: - **Program indicators** associated with the program (derived from programStageId) - Enrollment analytics dimensions - **Tracked entity attributes** of *supported types* associated with the program (derived from programStageId) ### “已跟踪实体”分析维度{ #tracked-entities-analytics-dimensions } #### 与项目连接的**项目指示器** **Data elements** of *supported types* in the program, with program stage for each data element **Tracked entity attributes** of *supported types* associated with the program that are not confidential - All value types for data elements and tracked entity attributes are considered *supported types*, except `IMAGE` and `FILE_RESOURCE`. - Enrollment aggregate dimensions { #webapi_enrollment_aggregate_analytics_dimension } - **Data elements** of *supported types* in the program stage - **Data elements** of *supported types* in the program, with program stage for each data element 除 `IMAGE`、`FILE_RESOURCE` 和 `TRACKER_ASSOCIATE` 之外,数据元素和受跟踪实体属性的所有值类型均被视为 *受支持的类型*。 ### 请求和响应示例{ #sample-request-and-response } `NUMBER`
{
"page":1,
"total":5,
"pageSize":50,
"dimensions":[
{
"dimensionType":"PROGRAM_INDICATOR",
"created":"2015-08-06T22:49:20.128",
"lastUpdated":"2015-08-06T22:51:19.787",
"name":"麻疹+黄热病疫苗剂量适用于低体重婴儿",
"displayName":"麻疹+黄热病疫苗剂量适用于低体重婴儿",
"id":"tt54DiKuQ9c",
"uid":"tt54DiKuQ9c",
"displayShortName":"麻疹+黄热病疫苗接种剂量不足(低体重婴儿)"
},
{
"dimensionType":"PROGRAM_INDICATOR",
"created":"2017-01-20T10:32:26.388",
"lastUpdated":"2017-01-20T10:32:26.388",
"name":"出生至最后一次产后随访期间的体重增长(单位:克)",
"displayName":"出生至最后一次产后随访期间的体重增长(单位:克)",
"id":"qhTkqwAJLMv",
"uid":"qhTkqwAJLMv",
"displayShortName":"体重增加(克)"
},
{
"dimensionType":"PROGRAM_INDICATOR",
"created":"2015-09-14T20:25:55.543",
"lastUpdated":"2018-08-28T12:22:47.857",
"name":"平均体重 (g)",
"displayName":"平均体重 (g)",
"id":"GxdhnY5wmHq",
"uid":"GxdhnY5wmHq",
"displayShortName":"平均重量 (g)"
},
{
"维度类型":"PROGRAM_INDICATOR",
"创建时间":"2015-08-06T22:35:40.391",
"lastUpdated":"2015-08-06T22:35:40.391",
"name":"低出生体重儿卡介苗接种剂量",
"displayName":"低出生体重儿卡介苗接种剂量",
"id":"hCYU0G5Ti2T",
"uid":"hCYU0G5Ti2T",
"displayShortName":"低出生体重儿卡介苗接种剂量"
},
{
"valueType":"NUMBER",
"dimensionType":"DATA_ELEMENT",
"created":"2012-09-20T17:37:45.474",
"lastUpdated":"2014-11-11T21:56:05.418",
"name":"MCH 体重 (g)",
"displayName":"MCH 体重 (g)",
"id":"A03MvHHogjR.UXz7xuGCEhU",
"uid":"UXz7xuGCEhU",
"code":"DE_2005736",
"displayShortName":"重量 (g)"
}
]
}
需要
欧
Org unit identifiers, potentially separated by a semicolon.
是的
ougs
Org unit group set identifiers, potentially separated by a semicolon.
### 价值
列
| json(应用项目/ json) | Validation report |
| ---------- | ------- |
| 响应将包含用于父组织单位的列,用于请求的每个组织单位组集部分的列以及用于计数的列。统计信息包括组织单位的数量,该组织单位是请求中指定的组织单位的子层次结构的一部分。该响应包含一个元数据部分,该元数据部分指定由其标识符引用的响应的每个组织单位和组织单位组部分的名称。 | 默认响应使用单个 `count` 列进行标准化。通过使用 `columns` 查询参数指定至少一个组织单位组集,可以在表格布局中呈现响应。 |
| Response formats | 组织单位分析端点支持以下表示格式: |
## json(应用项目/ json)
csv(应用项目/ csv)
xls(application / vnd.ms-excel)
### `vr = <UID>`以匹配验证规则的所有验证结果;提供多个参数时,多个规则组合或
例子
要获取组织单位和组织单位组集的组织单位分析,请执行以下操作:
| 默认值 | Parameter name | Potential duplicate status | 检索和删除项目通知模板 |
|---|---|---|---|
| Table: Query parameters | Constraints and validation | 下表描述了专门针对组织单位分析API的可能的验证错误。为汇总分析API指定的某些错误也相关。 | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` |
| E7228 | E7300 | 必须至少指定一个组织单位 | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` |
| Filter on whether the current user can manage the returned users through the managed user group relationships. | 数据集报告 { #webapi_data_set_report } | 可以使用 web api 生成数据集报告
`/dataSetReport` 资源。此资源生成有关数据集的报告
并以 HTML 表格的形式返回结果。 | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` |
| 数据值 | 该请求支持以下参数: | Table: Data set report query parameters | Program notification template |
| 描述 | 类型 | *userDataStore* 由用户、命名空间、键和关联的
值。用户、命名空间和密钥的组合是唯一的。 | Program notification template |
Data set to create the report from.
Data set UID
是的
聚乙烯
Period(s) to create the report from. May be a comma-separated list.
ISO String
是的
### 回应格式 { #response-formats }
Organisation unit to create the report from.
- 临界点
- Property
- Table: Org unit analytics query parameters
### 自订表格 { #custom-forms }
One or more UIDs
不
selectedUnitOnly
Whether to use captured data only or aggregated data.
## Boolean
不
The data set report resource accepts `GET` requests only. The response content type is `application/json` and returns data in a grid. This endpoint works for all types of data sets, including default, section and custom forms.
An example request to retrieve a report for a monthly data set and org unit for October 2018 looks like this:
GET /api/dataSetReport?ds=BfMAe6Itzgt&pe=201810&ou=ImspTQPwCqd&selectedUnitOnly=false
An example request to retrieve a report for a monthly data set and org unit for October, November, and December 2018 looks like this:
GET /api/dataSetReport?ds=BfMAe6Itzgt&pe=201810,201811,201812&ou=ImspTQPwCqd&selectedUnitOnly=false
要获得带有过滤器的数据集报告,可以使用`filter`参数。在这种情况下,过滤器基于一个组织单位组集和两个组织单位组:
| 指标组 | Parameter name | Potential duplicate status | 检索和删除项目通知模板 |
|---|---|---|---|
| pdf(应用项目/ pdf) | xls(application / vnd.ms-excel) | Custom forms | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` |
| 技术性更强、对开发人员更友好的消息(目前尚未使用)。 | 否则,此端点的语法等于常规数据集报告端点。要检索自定义HTML数据集报告,您可以发出如下请求: | 具有以下要求: | Program notification template |
| 推送分析 API 包括用于预览推送分析的端点
报告登录用户并手动触发系统
生成和发送推送分析报告,除了正常的 CRUD
操作。使用创建和更新端点进行推送时
分析,推送分析将根据
推分析的性质。删除或更新一个
禁用推送分析,作业也将停止运行
将来。 | 要获得现有推送分析的 HTML 预览,您可以执行 GET
请求到以下端点: | /api/pushAnalysis/<id>/render | 要手动触发推送分析作业,您可以执行 POST 请求以
这个端点: |
| /api/pushAnalysis/<id>/run | 推送分析包含以下属性,其中一些是
自动运行推送分析作业所需: | *userDataStore* 由用户、命名空间、键和关联的
值。用户、命名空间和密钥的组合是唯一的。 | Property |
| 描述 | 类型 | 需要 | dashboard |
| Dashboard on which reports are based | Dashboard UID | 是的 | message |
## Appears after title in reports
串
不
recipientUserGroups
### A set of user groups who should receive the reports
One or more user Group UID
- No. Scheduled jobs without any recipient will be skipped.
- enabled
### Indicated whether this push analysis should be scheduled or not. False by default.
Boolean
Yes. Must be true to be scheduled.
schedulingFrequency
The frequency of which reports should be scheduled.
"DAILY", "WEEKLY", "MONTHLY"
| To send an email with an HTML body, you can simply provide the HTML content
in the `message` parameter. The email client should interpret the
HTML and render it accordingly. Note that the `Content-Type` header in
the `curl` command should be `application/x-www-form-urlencoded`, as the
data is sent as URL-encoded form data. The following example shows how
to send an email with a simple HTML table: | Parameter name |
|---|---|
| The day in the frequency the job should be scheduled. | Integer. Any value when frequency is "DAILY". 0-7 when frequency is "WEEKLY". 1-31 when frequency is "MONTHLY" |
| No. Push analysis without a valid day of frequency for the frequency set will not be scheduled. | 数据使用情况分析 { #webapi_usage_analytics } |
| 使用情况分析 API 可让您访问有关人们使用情况的信息
使用基于数据分析的 DHIS2。当用户访问收藏夹时,
事件被记录。事件由用户名、UID 组成
最喜欢的、事件发生的时间以及事件的类型。这
表中列出了不同类型的事件。 | /api/dataStatistics |
| 使用情况分析 API 可让您检索使用情况的汇总快照
基于时间间隔的分析。 API 捕获用户视图(对于
例如,图表或数据透视表被用户查看的次数
用户)和保存的分析收藏夹(例如收藏夹图表和
数据透视表)。 DHIS2 将捕获夜间快照,然后
应要求汇总。 | 请求查询参数 { #webapi_usage_analytics_request_query_parameters } |
| 使用情况分析(数据统计)API支持两种操作: | *POST:* 创建一个视图事件 |
| *GET:* 检索汇总统计信息 | 创建视图事件(POST) { #webapi_usage_analytics_create_view_events } |
| 使用情况分析 API 可让您创建事件视图。这
dataStatisticsEventType 参数描述了项目的类型
看过。最喜欢的参数表示相关的标识符
最喜欢的。 | 创建新事件视图的 URL
图表: |
| POST /api/dataStatistics?eventType=CHART_VIEW&favorite=LW0O27b7TdD | 成功的保存操作会返回 HTTP 状态代码 201。表
下面显示了支持的事件类型。 |
### Table: Supported event types
键
描述
| eventCreatedPeriod | 检索和删除项目通知模板 | Parameter name | 用户设置 { #webapi_user_settings } |
|---|---|---|---|
| dueDate | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` | EVENT_CHART_VIEW | Event chart view |
| lastUpdatedDate | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` | DASHBOARD_VIEW | Event chart view |
| PASSIVE_DASHBOARD_VIEW | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` | DATA_SET_REPORT_VIEW | Data set report view |
检索汇总的使用情况分析报告(GET) { #webapi_aggregated_usage_analytics }
使用情况分析(数据统计)API 允许您指定特定查询
请求汇总报告时的参数。
Table: Query parameters for aggregated usage analytics (data statistics)
### 查询参数
需要
描述
| eventCreatedPeriod | 检索和删除项目通知模板 | Parameter name | 用户设置 { #webapi_user_settings } |
|---|---|---|---|
| Date in yyyy-MM-dd format | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` | 是的 | End date for period |
| 定义每页返回的元素数量。 | Program notification template | 是的 | Type of interval to be aggregated |
| 这种访问级别的限制稍多一些。受保护项目中的数据只有在所有者组织单位属于用户捕获范围的情况下才能被用户访问。
只有当所有者组织单位属于用户的捕获范围时,用户才能访问受保护项目内的数据。但是,如果用户
用户可以通过 [打破玻璃](#webaptrl) 获得临时所有权。
玻璃](#webapi_tracker_ownership_override)获得临时所有权。用户必须说明为什么要访问手头的数据。
他们为什么要访问手头的数据。然后,系统会将理由和访问审核记录在案,并提供 3 个月的临时访问权限。
访问审计日志,并为用户提供 3 小时的临时访问权限。请注意,打破玻璃时
时,所有者组织单位保持不变,只有打碎玻璃的用户才能获得临时访问权。
获得临时访问权。 | Program notification template | 用于创建每月查询的 API 查询
聚合: | GET /api/dataStatistics?startDate=2014-01-02&endDate=2016-01-01&interval=MONTH |
| createdBy | Program notification template | Table: Query parameters for top favorites | 查询参数 |
需要
描述
选项
eventType
### 是的
The data statistics event type
- 临界点
- E7126
- One or more headers name separated by comma
Size of the list returned
For example 5, 10, 25. Default is 25
sortOrder
不
Descending or ascending
ASC or DESC. Default is DESC.
用户名
### 不
If specified, the response will only contain favorites by this user.
For example 'admin'
API 查询可以不用用户名,然后会找到顶部
系统的最爱。
/api/dataStatistics/favorites?eventType=CHART_VIEW&pageSize=25&sortOrder=ASC
## 如果指定了用户名,则响应将仅包含该用户的最爱。
/api/dataStatistics/favorites?eventType=CHART_VIEW&pageSize=25
&sortOrder=ASC&username=admin
回应格式 { #webapi_usage_analytics_response_format }
您可以在使用情况分析响应中返回聚合数据
几种表示格式。默认格式为 JSON。这
可用的格式和内容类型有:
json(应用项目/ json)
xml(应用项目/ xml)
html(text / html)
- 请求 XML 格式的使用情况分析响应的 API 查询
格式:
- /api/dataStatistics.xml?startDate=2014-01-01&endDate=2016-01-01&interval=WEEK
要以 JSON 格式获取使用情况分析响应:
/api/dataStatistics?startDate=2016-02-01&endDate=2016-02-14&interval=WEEK
JSON响应如下所示:
```json
[
{
"year": 2016,
"week": 5,
"mapViews": 2181,
"chartViews": 2227,
"reportTableViews": 5633,
"eventReportViews": 6757,
"eventChartViews": 9860,
"eventVisualizationViews": 2387,
"dashboardViews": 10082,
"passiveDashboardViews": 0,
"totalViews": 46346,
"averageViews": 468,
"averageMapViews": 22,
"averageChartViews": 22,
"averageReportTableViews": 56,
"averageEventReportViews": 68,
"averageEventChartViews": 99,
"averageEventVisualizationViews": 10,
"averageDashboardViews": 101,
"averagePassiveDashboardViews": 0,
"savedMaps": 1805,
"savedCharts": 2205,
"savedReportTables": 1995,
"savedEventReports": 1679,
"savedEventCharts": 1613,
"savedEventVisualizations": 1231,
"savedDashboards": 0,
"savedIndicators": 1831,
"activeUsers": 99,
"users": 969
},
{
"year": 2016,
"week": 6,
"mapViews": 2018,
"chartViews": 2267,
"reportTableViews": 4714,
"eventReportViews": 6697,
"eventChartViews": 9511,
"dashboardViews": 12181,
"passiveDashboardViews": 0,
"totalViews": 47746,
"averageViews": 497,
"averageMapViews": 21,
"averageChartViews": 23,
"averageReportTableViews": 49,
"averageEventReportViews": 69,
"averageEventChartViews": 99,
"averageDashboardViews": 126,
"averagePassiveDashboardViews": 0,
"savedMaps": 1643,
"savedCharts": 1935,
"savedReportTables": 1867,
"savedEventReports": 1977,
"savedEventCharts": 1714,
"savedDashboards": 0,
"savedIndicators": 1646,
"activeUsers": 96,
"users": 953
}
]
{
"name": "Update 'Currently on treatment' data in analytics table",
"phase": "ANALYTICS_TABLE_POPULATED",
"analyticsTableType": "DATA_VALUE",
"sql": "update analytics_temp set monthly = '200212' where monthly in ('200210', '200211')"
}
SVG转换 { #webapi_svg_conversion }
| eventCreatedPeriod | Parameter name | 检索和删除项目通知模板 | Attribute identifiers |
|--------------------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------|
| Table: Query parameters | <indicator-id\> | ```json
{
"name": "Case notification",
"notificationTrigger": "ENROLLMENT",
"subjectTemplate": "Case notification V{org_unit_name}",
"displaySubjectTemplate": "Case notification V{org_unit_name}",
"notifyUsersInHierarchyOnly": false,
"sendRepeatable": false,
"notificationRecipient": "ORGANISATION_UNIT_CONTACT",
"notifyParentOrganisationUnitOnly": false,
"displayMessageTemplate": "Case notification A{h5FuguPFF2j}",
"messageTemplate": "Case notification A{h5FuguPFF2j}",
"deliveryChannels": [
"EMAIL"
]
}
``` | 描述 |
| dueDate | 是的 | Analytics outlier detection { #webapi_analytics_outlier_detection } | ds |
| lastUpdatedDate | The file name for the returned attachment without file extension | Analytics outlier detection { #webapi_analytics_outlier_detection } | ds |
| E7228 | Request { #webapi_analytics_outlier_detection_request } | **Query parameters** | 查询参数 |
| 描述 | 需要 | Program notification template | ds |
| Filter on whether the current user can manage the returned users through the managed user group relationships. | 是的 | Program notification template | 开始日期 |
| Start date for interval tocheck for outliers | No (relative date period is mandatory in this case) | Program notification template | 结束日期 |
| End date for interval to check for outliers | No (relative date period is mandatory in this case) | Program notification template | 聚乙烯 |
| 这种访问级别的限制稍多一些。受保护项目中的数据只有在所有者组织单位属于用户捕获范围的情况下才能被用户访问。
只有当所有者组织单位属于用户的捕获范围时,用户才能访问受保护项目内的数据。但是,如果用户
用户可以通过 [打破玻璃](#webaptrl) 获得临时所有权。
玻璃](#webapi_tracker_ownership_override)获得临时所有权。用户必须说明为什么要访问手头的数据。
他们为什么要访问手头的数据。然后,系统会将理由和访问审核记录在案,并提供 3 个月的临时访问权限。
访问审计日志,并为用户提供 3 小时的临时访问权限。请注意,打破玻璃时
时,所有者组织单位保持不变,只有打碎玻璃的用户才能获得临时访问权。
获得临时访问权。 | No (start and end date is mandatory in this case) | Program notification template | relativePeriodDate |
| Date used as basis for relative periods. | 不 | Program notification template | 欧 |
| Organisation unit, organisation unit level or groups (can be combined) | 不 | Program notification template | 标头 |
| The name of the headers to be returned as part of the response. One or more headers name separated by comma | 不 | Program notification template | 订购 |
| Sort the records on the value column | 不 | Program notification template | 500 |
| sortOrder | Sort the records on the value column in ascending or descending order | Program notification template | 跳过验证 |
算法
Algorithm to use for outlier detection
### 不
Z_SCORE, MODIFIED_Z_SCORE
- 临界点
- E7126
- 不
- 组织单位分析资源使您可以指定一系列查询参数:
- One or more headers name separated by comma
- page
不
```json
{
"headers": [
{
"name": "dx",
"column": "Data",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "dxname",
"column": "数据名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "pe",
"column": "周期",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "pename",
"column": "周期名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ou",
"column": "组织单位",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ouname",
"column": "组织单位名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "ounamehierarchy",
"column": "组织单位名称层级结构",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "coc",
"column": "类别选项下拉菜单",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "cocname",
"column": "类别选项下拉菜单名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "aoc",
"column": "属性选项下拉列表",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "aocname",
"column": "属性选项下拉菜单名称",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": false
},
{
"name": "value",
"column": "值",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "mean",
"column": "Mean",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "stddev",
"column": "标准差",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "absdev",
"column": "绝对偏差",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "zscore",
"column": "zScore",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "lowerbound",
"column": "下界",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
},
{
"name": "upperbound",
"column": "上界",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
}
],
"metaData": {
"maxResults": 30,
"count": 3,
"orderBy": "VALUE",
"threshold": 3.0,
"algorithm": "Z_SCORE"
},
"rowContext": {},
"width": 18,
"rows": [
[
"DE_22",
"Q_卡介苗接种时的早期母乳喂养(分娩后1小时内)",
"202209",
"2022年9月",
"OU_204860",
"桑达鲁社区卫生中心",
"/塞拉利昂/卡伊拉洪/彭圭亚/桑达鲁社区卫生中心",
"COC_292",
"固定, <1岁",
"默认",
"默认",
"105.0",
"18.3",
"28.7",
"86.7",
"3.0",
"-67.9",
"104.4"
],
[
"DE_359706",
"已接种的卡介苗剂次",
"202208",
"2022年8月",
"OU_595",
"Ngalu CHC",
"/塞拉利昂/博城/巴尔格贝/Ngalu CHC",
"COC_292",
"固定,<1岁",
"默认",
"默认",
"220.0",
"41.6",
"57.4",
"178.3",
"3.1",
"-130.7",
"213.9"
],
[
"DE_35",
"已接种的黄热病疫苗剂量",
"202209",
"2022年9月",
"OU_1027",
"耶莫镇社区卫生中心",
"/塞拉利昂/博市/卡库阿/耶莫镇社区卫生中心",
"COC_292",
"固定,<1岁",
"默认",
"默认",
"466.0",
"48.1",
"114.2",
"417.8",
"3.6",
"-294.6",
"391.0"
]
],
"headerWidth": 18,
"height": 3
}
{
"httpStatus": "Conflict",
"httpStatusCode": 409,
"status": "ERROR",
"message": "必须指定开始日期和结束日期或相对时间段",
"errorCode": "E2201"
}
{
"headers": [
{
"name": "dx",
"column": "Data",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "ou",
"column": "组织单位",
"valueType": "TEXT",
"type": "java.lang.String",
"hidden": false,
"meta": true
},
{
"name": "value",
"column": "值",
"valueType": "NUMBER",
"type": "java.lang.Double",
"hidden": false,
"meta": false
}
],
"metaData": {
"items": {
"ImspTQPwCqd": {
"uid": "ImspTQPwCqd",
"code": "OU_525",
"name": "塞拉利昂",
"dimensionItemType": "ORGANISATION_UNIT",
"valueType": "NUMBER",
"totalAggregationType": "SUM"
},
"sB79w2hiLp8": {
"uid": "sB79w2hiLp8",
"name": "产前检查第3次覆盖率",
"description": "按预计孕妇人数划分的第三次产前检查(固定点和外展服务)总次数。",
"图例集": "fqs276KXCXi",
"维度项目类型": "指标",
"值类型": "数字",
"totalAggregationType": "AVERAGE",
"indicatorType": {
"name": "百分比",
"displayName": "百分比",
"factor": 100,
"number": false
}
},
"dx": {
"uid": "dx",
"name": "数据",
"dimensionType": "DATA_X"
},
"pe": {
"uid": "pe",
"name": "时间段",
"dimensionType": "PERIOD"
},
"ou": {
"uid": "ou",
"name": "组织单位",
"dimensionType": "ORGANISATION_UNIT"
},
"Uvn6LCg7dVU": {
"uid": "Uvn6LCg7dVU",
"code": "IN_52486",
"name": "首次产前检查(ANC 1)覆盖率",
"description": "按预计孕产妇人数计算的首次产前检查(ANC 1)总就诊次数(包括固定诊所和外展服务)。",
"图例集": "fqs276KXCXi",
"维度项目类型": "指标",
"值类型": "数字",
"总聚合类型": "平均值",
"indicatorType": {
"name": "百分比",
"displayName": "百分比",
"factor": 100,
"number": false
}
},
"THIS_YEAR": {
"name": "今年"
},
"2022": {
"uid": "2022",
"code": "2022",
"name": "2022",
"dimensionItemType": "PERIOD",
"valueType": "NUMBER",
"totalAggregationType": "SUM",
"startDate": "2022-01-01T00:00:00.000",
"endDate": "2022-12-31T00:00:00.000"
}
},
"dimensions": {
"dx": [
"Uvn6LCg7dVU",
"sB79w2hiLp8"
],
"pe": [
"2022"
],
"ou": [
"ImspTQPwCqd"
],
"co": []
}
},
"performanceMetrics": {
"totalTimeInMillis": 90.894,
"executionPlans": [
{
"timeInMillis": 12.314,
"planningTime": 6.801,
"executionTime": 5.513,
"query": "select ax.\"dx\", ax.\"uidlevel1\", sum(daysxvalue) / 365 as value from analytics_2022 as ax where ax.\"dx\" in ('h0xKKjijTdI') and ax.\"uidlevel1\" in ('ImspTQPwCqd') and ( ax.\"yearly\" in ('2022') ) and ax.\"year\" in (2022) group by ax.\"dx\",ax.\"uidlevel1\"",
"plan": {
"Node Type": "Aggregate",
"策略": "排序",
"部分模式": "简单",
"支持并行": false,
"支持异步": false,
"启动成本": 20.21,
"总成本": 5602.98,
"计划行数": 260,
"计划宽度": 32,
"实际启动时间": 5.448,
"实际总时间": 5.449,
"实际行数": 1,
"实际循环次数": 1,
"分组键": [
"dx",
"uidlevel1"
],
"执行计划": [
{
"节点类型": "位图堆扫描",
"父子关系": "外层",
"支持并行": false,
"支持异步": false,
"关系名": "analytics_2022",
"别名": "ax",
"启动成本": 20.21,
"总成本": 5588.33,
"计划行数": 1520,
"计划宽度": 32,
"实际启动时间": 0.446,
"实际总时间": 5.003,
"实际行数": 1032,
"实际循环次数": 1,
"条件重新检查": "(dx = 'h0xKKjijTdI'::bpchar)",
"通过索引重新检查移除的行数": 0,
"过滤条件": "((uidlevel1 = 'ImspTQPwCqd'::bpchar) AND (yearly = '2022'::text) AND (year = 2022))",
"由过滤条件移除的行数": 0,
"精确堆块": 46,
"有损堆块": 0,
"执行计划": [
{
"节点类型": "位图索引扫描",
"父子关系": "外层",
"支持并行": false,
"支持异步": false,
"索引名称": "in_dx_ao_ax_2022_MClNI",
"启动成本": 0.0,
"总成本": 19.83,
"执行计划行数": 1520,
"执行计划宽度": 0,
"实际启动时间": 0.406,
"实际总时间": 0.407,
"实际行数": 1032,
"实际循环次数": 1,
"索引条件": "(dx = 'h0xKKjijTdI'::bpchar)"
}
]
}
]
}
},
{
"timeInMillis": 38.35,
"planningTime": 0.627,
"executionTime": 37.723,
"query": "select ax.\"dx\", ax.\"uidlevel1\", sum(value) as value from analytics_2022 as ax where ax.\"dx\" in ('Jtf34kNZhzP') and ax.\"uidlevel1\" in ('ImspTQPwCqd') and ( ax.\"yearly\" in ('2022') ) and ax.\"year\" in (2022) group by ax.\"dx\",ax.\"uidlevel1\"",
"plan": {
"Node Type": "Aggregate",
"Strategy": "Sorted",
"Partial Mode": "Simple",
"支持并行": false,
"支持异步": false,
"启动成本": 193.57,
"总成本": 47322.83,
"计划行数": 261,
"计划宽度": 32,
"实际启动时间": 37.685,
"实际总时间": 37.685,
"实际行数": 1,
"实际循环次数": 1,
"分组键": [
"dx",
"uidlevel1"
],
"执行计划": [
{
"节点类型": "位图堆扫描",
"父级关系": "外层",
"支持并行": false,
"支持异步": false,
"关系名称": "analytics_2022",
"别名": "ax",
"启动成本": 193.57,
"总成本": 47191.38,
"计划行数": 17179,
"计划宽度": 32,
"实际启动时间": 1.981,
"实际总时间": 32.332,
"实际行数": 17462,
"实际循环次数": 1,
"重新检查条件": "(dx = 'Jtf34kNZhzP'::bpchar)",
"通过索引重新检查移除的行数": 0,
"过滤条件": "((uidlevel1 = 'ImspTQPwCqd'::bpchar) AND (yearly = '2022'::text) AND (year = 2022))",
"通过过滤器移除的行数": 0,
"精确堆块": 1165,
"有损堆块": 0,
"执行计划": [
{
"节点类型": "位图索引扫描",
"父子关系": "外层",
"支持并行": false,
"支持异步": false,
"索引名称": "in_dx_ax_2022_Eb64F",
"初始化开销": 0.0,
"总开销": 189.27,
"执行计划行数": 17179,
"执行计划宽度": 0,
"实际初始化时间": 1.765,
"实际总时间": 1.765,
"实际行数": 17462,
"实际循环次数": 1,
"索引条件": "(dx = 'Jtf34kNZhzP'::bpchar)"
}
]
}
]
}
}
]
},
"width": 0,
"rows": [],
"height": 0,
"headerWidth": 2
}
{
"httpStatus": "Conflict",
"httpStatusCode": 409,
"status": "ERROR",
"message": "Start date and end date or relative period must be specified",
"errorCode": "E2201"
}