分析工具¶
分析工具¶
要访问 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
order 参数可用于分析资源生成 有序数据。数据将按升序（或降序）排序 值。以降序对值进行排序的示例请求 顺序是：
不
尺寸和项目¶
false | true
dimension 查询参数定义了哪些维度应该是 包含在分析查询中。可以是任意数量的维度 指定的。每个维度都应该重复维度参数 包含在查询响应中。查询响应可能 包含指定的所有组合的聚合值 维度项。
| 尺寸 | 值不引用数字元素或项目一部分的数据元素或属性 | aggregationType 查询参数允许您定义哪个聚合 运算符应该用于查询。默认情况下,聚合 将使用为查询中包含的数据元素定义的运算符。 如果您的查询不包含任何数据元素但包含数据 元素组,第一个数据元素的聚合运算符 将使用第一组。组和数据元素的顺序是 不明确的。此查询参数允许您覆盖默认值和 指定特定的聚合运算符。例如,您可以设置 使用以下 URL 进行“计数”的聚合运算符: | |---|---|---| | /api/analytics?dimension=dx:fbfJHSPpUQD&dimension=pe:2014Q1&dimension=ou:O6uvpzGd5pu &aggregationType=COUNT | measureCriteria 查询参数可让您过滤掉数据范围 要返回的记录。您可以指示系统仅返回记录 其中聚合数据值等于、大于、大于或 等于、小于或小于或等于某些值。您可以指定任何 以下格式的标准数量,其中 criteria 和 value 应替换为实际值: | 数据元素、指标、数据集报告率指标、数据元素操作数、项目指标、项目属性标识符、关键字 DE_GROUP-<group-id>, IN_GROUP-<group-id>, 使用<dataelement-id>.<optioncombo-id> 表示数据元素操作数，<program-id>.<dataelement-id> 表示项目数据元素，<program-id>.<attribute-id> 表示项目属性，<validationrule-id> 表示验证结果。 | | 例如,以下查询将仅返回以下记录 数据值大于或等于 6500 且小于 33000: | 聚乙烯 | Fallback coordinate field is invalid | | /api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:2014 &dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw&preAggregationMeasureCriteria=GE:10;LT:100 | 欧 | /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: | | 分类目录 | 尺寸 | Dimension id | | 数据元素组集 | 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 | 欧 |
没有必要知道哪些对象用于 设计分析查询时的各种动态维度。你可以得到 通过访问 Web API 中的此 URL 获得动态维度的完整列表：
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)
分析资源的基本 URL 是/api/analytics。请求 您可以在其上使用查询字符串的特定维度和维度项目 以下格式，其中 dim-id 和 dim-item 应替换为实际值：
{
"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
}
{
"httpStatus": "Conflict",
"httpStatusCode": 409,
"status": "ERROR",
"message": "Only a single indicator can be specified as filter",
"errorCode": "E7108"
}
响应的 *headers* 部分描述了查询的内容
结果。事件唯一标识符、节目阶段标识符、
事件日期、组织单位名称、组织单位代码和
组织单位标识符显示为前六个维度
响应并将始终存在。接下来是数据元素，
指定为的人员属性和人员标识符
请求中的维度，在本例中为“性别”和“年龄”数据
元素尺寸。标题部分包含的标识符
“名称”属性中的维度项和可读维度
“列”属性中的描述。
*metaData* 部分，*ou* 对象包含映射到表示层次结构的字符串的响应中存在的所有组织单位的标识符。此层次结构字符串从根开始列出组织单位的祖先（父）的标识符。 *names* 对象包含响应中映射到其名称的所有项目的标识符。
*rows* 部分包含查询产生的事件。每一行
正好代表一个事件。
为了让事件分析资源在
一个现成的表格的形状，你可以提供*行*和*列*
具有请求的维度标识符的参数以分号分隔
作为值来指示哪些用作表列和行。
事件不是生成一个普通的、规范化的数据源
分析资源现在将生成表格布局中的数据。这
列和行维度必须作为数据维度出现在
查询（不是过滤器）。这样的请求可能如下所示：
例:
### 事件汇总分析 { #webapi_event_aggregate_analytics }
`/analytics/events/aggregate` 资源可让您检索 *aggregated
DHIS2 中捕获的事件数量*。此资源可让您检索
基于程序和可选的程序阶段聚合数据，以及
允许您过滤任何事件维度。
((a>20 and a<40) or (b>1 and b<5)) and c = "test"
事件聚合资源不返回事件信息
本身，而不是与请求匹配的事件总数
询问。事件维度包括数据元素、人员属性、人员
标识符、期间和组织单位。聚合事件查询
应该是下面描述的格式。
默认的响应表示格式是 JSON。请求必须使用 HTTP *GET* 方法。支持以下响应格式。
例如，要从
1 月至 10 月期间的“住院发病率和死亡率”计划
2016 年，其中包含“性别”和“年龄”数据元素，“年龄”
维度项目在“18”上过滤，“性别”项目在过滤上
“女性”，您可以使用以下查询：
jsonp(应用项目/ javascript)
检索固定和相对时期的数据，而不是开始和结束
日期，在本例中为 2016 年 5 月和过去 12 个月，以及组织
与当前用户关联的单位，可以使用以下查询：
例如,要获得Excel格式的响应,可以在请求URL中使用文件扩展名,如下所示:
为了将“女性”指定为数据的“性别”过滤器
响应，意思是“性别”不会是响应的一部分，但会
过滤其中的聚合数字，您可以使用以下语法：
您可以将hierarchyMeta 查询参数设置为true,以便
在元部分中包括所有祖先组织单位的名称
响应:
要将“Bo”组织单位和期间“2016”指定为过滤器，
和“放电方式”和“性别”作为维度，其中“性别”是
在“男性”项目上过滤，您可以使用这样的查询：
默认响应JSON格式将类似于以下内容:
要为_出院模式_创建“前 3 名报告”，您可以使用限制
和 sortOrder 查询参数类似：
响应的* header *部分描述了查询的内容
结果。事件唯一标识符,项目阶段标识符,
活动日期,组织单位名称,组织单位代码和
组织单位标识符显示为的前六个维度
回应,并将永远存在。接下来是数据元素
指定为的人员属性和人员标识符
请求中的尺寸,在这种情况下,为“性别”和“年龄”数据
元素尺寸。标头部分包含
“名称”属性中的尺寸项目和可读尺寸
“列”属性中的说明。
要指定具有相应聚合类型的值维度，您
可以使用 value 和aggregationType 查询参数。指定一个
值维度将使分析引擎返回聚合值
对于响应中该维度的值，而不是计数
事件。
*rows* 部分包含查询产生的事件。每一行
正好代表一个事件。
基于特定数据元素或属性的事件分析聚合
对于值类型日期或日期时间，您可以使用 `timeField` 参数：
/api/analytics.html+css?dimension=dx:cYeuwXTCPkU;fbfJHSPpUQD&dimension=pe:WEEKS_THIS_YEAR
&filter=ou:ImspTQPwCqd&displayProperty=SHORTNAME&columns=dx&rows=pe
基于特定数据元素或属性的事件分析聚合
对于值类型的组织单元，您可以使用 `orgUnitField` 参数：
`/analytics/events/aggregate` 资源可让您检索 *aggregated
DHIS2 中捕获的事件数量*。此资源可让您检索
基于项目和可选的项目阶段聚合数据,以及
允许您过滤任何事件维度。
/api/analytics/events/aggregate
| 事件聚合资源不返回事件信息
本身,而不是与请求匹配的事件总数
询问。事件维度包括数据元素、人员属性、人员
标识符、期间和组织单位。聚合事件查询
应该是下面描述的格式。 | 描述 |
| --- | --- |
| 例如,要从
1 月至 10 月期间的“住院发病率和死亡率”计划
2016 年,其中包含“性别”和“年龄”数据元素,“年龄”
维度项目在“18”上过滤,“性别”项目在过滤上
“女性”,您可以使用以下查询: | /api/analytics/events/aggregate/eBAyeGv0exc?startDate=2016-01-01&endDate=2016-10-31
&dimension=ou:O6uvpzGd5pu&dimension=oZg33kd9taw:EQ:Female&dimension=qrur9Dvnyt5:GT:50 |
| 检索固定和相对时期的数据,而不是开始和结束
日期,在本例中为 2016 年 5 月和过去 12 个月,以及组织
与当前用户关联的单位,可以使用以下查询: | /api/analytics/events/aggregate/eBAyeGv0exc?dimension=pe:201605;LAST_12_MONTHS
&dimension=ou:USER_ORGUNIT;fdc6uOvgo7ji&dimension=oZg33kd9taw |
| 为了将“女性”指定为数据的“性别”过滤器
响应,意思是“性别”不会是响应的一部分,但会
过滤其中的聚合数字,您可以使用以下语法: | /api/analytics/events/aggregate/eBAyeGv0exc?dimension=pe:2016;
&dimension=ou:O6uvpzGd5pu&filter=oZg33kd9taw:EQ:Female |
| 注册 | /api/analytics/events/aggregate/eBAyeGv0exc?filter=pe:2016&filter=ou:O6uvpzGd5pu
&dimension=fWIAEtYVEGk&dimension=oZg33kd9taw:EQ:Male |
| 要为_出院模式_创建“前 3 名报告”,您可以使用限制
和 sortOrder 查询参数类似: | /api/analytics/events/aggregate/eBAyeGv0exc?filter=pe:2016&filter=ou:O6uvpzGd5pu
&dimension=fWIAEtYVEGk&limit=3&sortOrder=DESC |
| 要指定具有相应聚合类型的值维度,您
可以使用 value 和aggregationType 查询参数。指定一个
值维度将使分析引擎返回聚合值
对于响应中该维度的值,而不是计数
事件。 | /api/analytics/events/aggregate/eBAyeGv0exc.json?stage=Zj7UnCAulEk
&dimension=ou:ImspTQPwCqd&dimension=pe:LAST_12_MONTHS&dimension=fWIAEtYVEGk
&value=qrur9Dvnyt5&aggregationType=AVERAGE |
#### 范围/图例集 { #ranges-legend-sets }
对于聚合查询，您可以为数值指定范围/图例集
数据元素和属性维度。目的是将
数值范围内。举个例子，而不是生成数据
对于不同年份的“年龄”数据元素，您可以将
年龄组的信息。为了实现这一点，数据元素或
属性必须与图例集相关联。格式是
如下面所描述的：
？dimension = <item-id>-<legend-set-id>
一个示例如下所示：
The `orgUnitField` parameter value may be one of the following:
#### 回应格式 { #response-formats }
默认的响应表示格式是 JSON。请求必须是
使用 HTTP *GET* 方法。响应将类似于以下内容：
```json
{
"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
}
{
"httpStatus": "Conflict",
"httpStatusCode": 409,
"status": "ERROR",
"message": "At least one organisation unit must be specified",
"errorCode": "E7200"
}
响应的 *headers* 部分描述了查询结果的内容。注册唯一标识符、被跟踪实体实例标识符、注册日期、事件日期、几何形状、纬度、经度、组织单位名称和组织单位代码作为响应中的第一个维度出现并且将始终存在。接下来是数据元素和在请求中指定为维度的跟踪实体属性，在本例中为“WHOMCH 慢性条件”和“WHOMCH 吸烟”数据元素维度。标题部分在“名称”属性中包含维度项的标识符，在“列”属性中包含可读的维度描述。
*metaData* 部分，*ou* 对象包含映射到表示层次结构的字符串的响应中存在的所有组织单位的标识符。此层次结构字符串从根开始列出组织单位的祖先（父）的标识符。 *names* 对象包含响应中映射到其名称的所有项目的标识符。
*rows* 部分包含查询生成的注册。每一行正好代表一个注册。
### 使用计划指标{ #analytics-across-tei-relationships-with-program-indicators }进行TEI关系分析 { #analytics-across-tei-relationships-with-program-indicators }
非汇总注册分析API还支持将程序指示器链接到关系类型，以显示应用于所列出的跟踪实体实例的相关实体的特定程序指示器的计算结果。
ENROLLMENT_DATE | LAST_UPDATED | <Attribute ID\> | <Data element ID\>
Response formats
例如，要从“ WHO RMNCH Tracker”程序中检索2019年1月的注册列表，并按“与人相关的疟疾病例”类型的关系显示与该注册相关的疟疾病例数，则可以使用以下查询
json(应用项目/ json)
API 支持使用与“主”程序（即在`/query/` 之后指定的程序 ID）无关的程序指示符。
## 跟踪实体分析{ #webapi_tei_analytics }
csv(应用项目/ csv)
### 尺寸和项目{ #webapi_tei_analytics_dimensions }
跟踪实体实例维度包括项目属性（TE 属性）、数据元素、
组织单位和不同种类的期间。分析查询只会返回与一组标准相匹配的 TE。
它不会执行任何聚合。
例如,要获得Excel格式的响应,可以在请求URL中使用文件扩展名,如下所示:
| 尺寸 | 值不引用数字元素或项目一部分的数据元素或属性 | 描述 |
|------------------------------------|-------------------------------------------------------------|---|
| 项目属性（TE 属性） | *metaData* 部分,*ou* 对象包含映射到表示层次结构的字符串的响应中存在的所有组织单位的标识符。此层次结构字符串从根开始列出组织单位的祖先(父)的标识符。 *names* 对象包含响应中映射到其名称的所有项目的标识符。 | 项目属性的标识符。
| 项目标识符未引用项目的任何数据元素,属性或指标部分 | 非汇总注册分析API还支持将项目指示器链接到关系类型,以显示应用于所列出的跟踪实体实例的相关实体的特定项目指示器的计算结果。 | 数据元素标识符必须包括项目和项目阶段，即：`dimension=IpHINAT79UW.ZzYYXq4fJie.GQY2lXrypjO`。 |
| 句号 | /api/analytics/enrollments/query/<program-id>
?dimension=<relationshiptype-id>.<programindicator-id> | 例如,要从“ WHO RMNCH Tracker”项目中检索2019年1月的注册列表,并按“与人相关的疟疾病例”类型的关系显示与该注册相关的疟疾病例数,则可以使用以下查询 |
| /api/analytics/enrollments/query/WSGAb5XwJ3Y.json?dimension=mxZDvSZYxlw.nFICjJluo74
&startDate=2019-01-01&endDate=2019-01-31 | `ou` | Dimension id |
| The tracked entity (TE) analytics API allows querying *TEs with their enrollments and event data* captured in DHIS2.
This resource retrieves data from TE, enrollments, events, and data elements across multiple programs, for a given tracked entity type. | Dimensions and items { #webapi_te_analytics_dimensions } | Dimension id |
| Table: TE dimensions | 尺寸 | Dimension id |
#### 偏移{ #offset }
项目属性(TE 属性)
例：
项目属性的标识符。
### Data elements in program stages
`<program id>.<program stage id>[offset].<data element id>`
数据元素标识符必须包括项目和项目阶段,即:`dimension=IpHINAT79UW.ZzYYXq4fJie.GQY2lXrypjO`。
句号
N.A.
There's no direct support for `period` dimension. Periods are supported through several different specific parameters. See the *Periods* section below.
TEI Organisation units
`ou`
Organisation unit identifiers, and also the keywords USER_ORGUNIT, USER_ORGUNIT_CHILDREN, USER_ORGUNIT_GRANDCHILDREN, LEVEL-<level\> and OU_GROUP-<group-id\>.
#### 筛选 { #filtering }
`<program id>.ou`
＆dimension = <item-id>：<operator>：<filter-value>
Event Organisation units
`<program id><program stage id>.ou`
#### 时期{ #periods }
Offset
| 默认值 | 描述 |
|----------------|----------------------------------------------------------------------------------|
| "assignedUsers": ["a3kGcGDCuk7", "a3kGcGDCuk8"] | Tracked entity (TE) query analytics { #webapi_te_query_analytics } |
| The *analytics/trackedEntities/query* endpoint provides queries for captured TEs, allowing querying and filtering for information related to TEs, along with their respective enrollments and events. It does not perform any aggregation. | /api/41/analytics/trackedEntities/query |
| You can specify any number of dimensions and any number of filters in a query. Dimension item identifiers can refer to any of the data elements in program stages, program attributes, tracked entity attributes, fixed and relative periods, and organization units. Dimensions can optionally have a query operator and a filter. TEs queries should be in the format described below. | /api/41/analytics/trackedEntities/query/<tracked-entity-type-id>?dimension=ou:<ou-id>;<ou-id>&
dimension=<item-id>&dimension=<item-id>:<operator>:<filter> |
| For example, to retrieve TEs of type `Person` from the "Child Program" and "Antenatal care" programs, where the "First name" is "James": | /api/41/analytics/trackedEntities/query/nEenWmSyUEp?program=IpHINAT79UW,WSGAb5XwJ3Y&dimension=IpHINAT79UW.w75KJ2mc4zz:eq:James |
| 不 | /api/41/analytics/trackedEntities/query/nEenWmSyUEp?program=IpHINAT79UW,WSGAb5XwJ3Y&dimension=IpHINAT79UW.w75KJ2mc4zz:eq:James
&pageSize=10&page=2 |
| GET /api/metadata/proposals?filter=status:eq:ACCEPTED | Filters can be applied to data elements, tracked entity attributes, and tracked entity identifiers. The filtering is done through a query parameter in the following format: |
&dimension = <item-id>:<operator>:<filter-value>
例子：
* &dimension=IpHINAT79UW.ZzYYXq4fJie.GQY2lXrypjO:GT:2000&dimension=IpHINAT79UW.ZzYYXq4fJie.GQY2lXrypjO:LT:4000
Periods
* Unlike enrollment and event query endpoints, the TE endpoint supports multiple ways to specify the period the data belongs to. They are based on different *date* params as shown below:
Parameter
* 描述
eventDate
* TEs will be filtered based on the date the event occurred.
enrollmentDate
### 请求查询参数{ #webapi_tei_analytics_query_parameters }
scheduledDate
TEs will be filtered based on the date the event was scheduled.
| 查询参数 | 需要 | 描述 | 选项（默认为默认） |
|-------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| trackedEntityType | 是的 | Some periods, mentioned above, can be applied to Tracked Entities, Enrollments, or Events, depending on the way they are expressed. | 例子: |
| 项目 | 不 | 项目标识符。 | 任何项目标识符。接受多个逗号分隔的标识符。 |
| 维度 | 不 | 维度标识符，包括数据元素、属性、计划指标、期间、组织单位和组织单位组集。该参数可指定多次。维度筛选器可应用于格式为<dimension-id\>:<operator\>:<filter-value\> 的维度。筛选值可以不区分大小写（取决于操作符）。 | 支持的运算符：eq | ieq | gt | ge | lt | le | ne | like | ilike | in |
| 数据值 | 不 | 维度标识符，包括数据元素、属性、期间、组织单位和组织单位组集。该参数可指定多次。维度筛选器可应用于格式为<dimension-id\>:<operator\>:<filter-value\> 的维度。筛选值可以不区分大小写（取决于操作符）。 | 支持的运算符：eq | ieq | gt | ge | lt | le | ne | like | ilike | in |
| 标头 | 不 | 作为响应的一部分返回的标头的名称。 | trackedEntityType |
| 描述 | 不 | Any tracked entity type identifier. | 项目 |
| `{"type":"RELATIVE","period":"TODAY"}` | 不 | 组织单位的选择模式。默认值为 DESCENDANTS，即层次结构中的所有子单位。子女（CHILDREN）指层次结构中的直系子女；选定（SELECTED）仅指选定的组织单位。 | 不 |
| Dimensions to use as columns for table layout. | 不 | Operators: EQ | IEQ | GT | GE | LT | LE | NE | LIKE | ILIKE | IN | filter |
| filter | 不 | Operators: EQ | IEQ | GT | GE | LT | LE | NE | LIKE | ILIKE | IN | filter |
| 定义要返回的页码。 | 不 | One or more header names (separated by a comma). | relativePeriodDate |
| 定义每页返回的元素数量。 | 不 | Example: "2016-01-01" | ouMode |
| Custom period on `lastUpdated`. See "custom date periods" section. | 不 | `DESCENDANTS`, `CHILDREN`, `SELECTED` | 查询参数 |
| 不 | 不 | `ouname` | `programstatus` | `createdbydisplayname` | `lastupdatedbydisplayname` | `enrollmentdate` | `incidentdate` | `lastupdated` | `<dimension identifier>` | 假 |
| ```json
{
"httpStatus": "OK",
"httpStatusCode": 200,
"status": "OK",
"response": {
"responseType": "ObjectReport",
"uid": "pG4bBTMiCqO",
"klass": "org.hisp.dhis.dataexchange.aggregate.AggregateDataExchange",
"errorReports": []
}
}
``` | 不 | `ouname` | `programstatus` | `createdbydisplayname` | `lastupdatedbydisplayname` | `enrollmentdate` | `incidentdate` | `lastupdated` | `<dimension identifier>` | page |
| 不 | 不 | Numeric positive value. | pageSize |
| 项目状态 | 不 | 指定要包含的事件的注册状态。*已删除，首选 `enrollmentStatus`* | includeMetadataDetails |
| DateTime | 不 | NAME | SHORTNAME | includeMetadataDetails |
| `"displayOrderColumns": ["enrollmentDate", "program"]` | 不 | false | true | outputIdScheme |
| 不 | 不 | UID | UUID | CODE | NAME | ATTRIBUTE:<ID\> | 假 |
| 不 | 不 | NAME | CODE | UID | 假 |
| 不 | 不 | ACTIVE | COMPLETED | CANCELLED. Can be comma separated (*for query only*). | enrollmentStatus |
| 不 | 不 | ACTIVE | COMPLETED | CANCELLED. Can be comma separated (*for query only*). | 假 |
| 不 | 不 | ACTIVE | COMPLETED | SCHEDULE | OVERDUE | SKIPPED. Can be comma separated (*for query only*). | 假 |
| sortOrder | 不 | false | true | 假 |
| 不 | 不 | false | true | 假 |
| Common request parameters | 不 | Any organization unit identifier. | 假 |
| Custom period on `lastUpdated`. See "custom date periods" section. | 不 | `DESCENDANTS`, `CHILDREN`, `SELECTED` | 查询参数 |
## 不
Skip data in the response.
- false | true
- skipRounding
- 不
- Skip rounding of data values.
- false | true
skipHeaders
| 查询参数 | Skip headers in the response. | 描述 | 选项 |
|-----------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| 数据值 | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | false | true | displayProperty |
| 默认过滤器是`id,displayName` | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | NAME | SHORTNAME |
| 定义要返回的页码。 | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | [Event Query data dimensions](analytics.md#webapi_event_query_analytics_dimension)`/analytics/events/query/dimensions` | [Event Aggregate data dimensions](analytics.md#webapi_event_aggregate_analytics_dimension) `/analytics/events/aggregate/dimensions` |
| 定义每页返回的元素数量。 | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | [Tracked Entities query data dimensions](analytics.md#webapi_teis_query_analytics_dimensions)) `/analytics/teis/query/dimensions` | Resources mentioned above share the following request parameter: |
| true | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | 描述 | 选项 |
| iasc 和 idesc 是不区分大小写的排序。如果需要对多个属性进行排序,请使用逗号将它们分开。 | [Enrollment Aggregate data dimensions](analytics.md#webapi_enrollment_aggregate_analytics_dimension) `/analytics/enrollments/aggregate/dimensions` | Allows field value filtering on the format: <br/> `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`<br/><br/> 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
项目和项目阶段的组合是有限制的：
- 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
- 与项目相关联的类别组合中的**类别**（源自项目阶段 ID）
- `like` - contains
除了 `IMAGE`、`FILE_RESOURCE` 和 `TRACKER_ASSOCIATE`，所有数据元素和跟踪实体属性的值类型都被视为*支持的类型*。
#### `ilike` - contains ignoring case
`!ilike` - does not contain ignoring case
- `eq` - equals
- `ieq` - equals ignoring case
- 与项目相关联的类别组合中的**类别**（源自项目阶段 ID）
- 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`.
- 与项目连接的**项目指示器**
- 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`
``json
{
"page":1、
"total":5、
"pageSize":50、
"尺寸":[
{
"dimensionType": "PROGRAM_INDICATOR"、
"created":"2015-08-06T22:49:20.128",
"lastUpdated":"2015-08-06T22:51:19.787",
"名称"："麻疹+黄热病剂量婴儿体重不足"、
"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",
"名称"："平均体重（克）"、
"displayName": "平均重量（克）"、
"id": "GxdhnY5wmHq"、
"uid": "GxdhnY5wmHq"、
"displayShortName"："平均体重（克）"。
},
{
"dimensionType": "PROGRAM_INDICATOR"、
"created":"2015-08-06T22:35:40.391",
"lastUpdated":"2015-08-06T22:35:40.391",
"名称"："卡介苗剂量低出生体重"、
"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",
"名称"："MCH 重量（克）"、
"displayName"："MCH 重量（克）"、
"id": "A03MvHHogjR.UXz7xuGCEhU"、
"uid": "UXz7xuGCEhU"、
"代码": "DE_2005736"、
"displayShortName"："重量（克）"。
}
]
}
{
"views": 3
}
[
{
"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 'Area' in org unit group set resource table",
"phase": "RESOURCE_TABLE_POPULATED",
"resourceTableType": "ORG_UNIT_GROUP_SET_STRUCTURE",
"sql": "update _organisationunitgroupsetstructure_temp set \"uIuxlbV1vRT\" = 'b0EsAxm8Nge'"
}
SVG转换 { #webapi_svg_conversion }
| 查询参数 | 描述 | 需要 | 选项（默认为默认） |
|--------------------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------|
| Table: Query parameters | 资料集 | 是的 | 描述 |
| 开始日期 | 是的 | Analytics outlier detection { #webapi_analytics_outlier_detection } | ds |
| 结束日期 | The file name for the returned attachment without file extension | Analytics outlier detection { #webapi_analytics_outlier_detection } | ds |
| 聚乙烯 | Request { #webapi_analytics_outlier_detection_request } | **Query parameters** | 查询参数 |
| 描述 | 需要 | 不 | ds |
| 欧 | 是的 | 不 | 开始日期 |
| 标头 | No (relative date period is mandatory in this case) | 不 | 结束日期 |
| 订购 | No (relative date period is mandatory in this case) | 不 | 聚乙烯 |
| 这种访问级别的限制稍多一些。受保护项目中的数据只有在所有者组织单位属于用户捕获范围的情况下才能被用户访问。
只有当所有者组织单位属于用户的捕获范围时,用户才能访问受保护项目内的数据。但是,如果用户
用户可以通过 [打破玻璃](#webaptrl) 获得临时所有权。
玻璃](#webapi_tracker_ownership_override)获得临时所有权。用户必须说明为什么要访问手头的数据。
他们为什么要访问手头的数据。然后,系统会将理由和访问审核记录在案,并提供 3 个月的临时访问权限。
访问审计日志,并为用户提供 3 小时的临时访问权限。请注意,打破玻璃时
时,所有者组织单位保持不变,只有打碎玻璃的用户才能获得临时访问权。
获得临时访问权。 | No (start and end date is mandatory in this case) | 不 | relativePeriodDate |
| 算法 | 不 | 不 | 欧 |
| 临界点 | 不 | 不 | 标头 |
| The name of the headers to be returned as part of the response. One or more headers name separated by comma | 不 | 不 | 订购 |
| Sort the records on the value column | 不 | 不 | 500 |
| sortOrder | Sort the records on the value column in ascending or descending order | 不 | 跳过验证 |
算法
Algorithm to use for outlier detection
### 不
Z_SCORE, MODIFIED_Z_SCORE
- json（应用程序/ json）
- xml（应用程序/ xml）
- 不
- csv（应用程序/ csv）
- html（text / html）
- html + css（text / html）
不
``json
{
"headers"：[
{
"name"："dx"、
"列"："数据"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"名称"："dxname"、
"列"："数据名称"、
"valueType"（值类型）： "TEXT"（文本"TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："pe"、
"列"："Period"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"名称"："pename"、
"列"："周期名称"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："ou"、
"列"："组织单位"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："ouname"、
"列"："组织单位名称"、
"valueType"："TEXT"、
类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："ounamehierarchy"、
"列"："组织单位名称层次"、
"valueType"："TEXT"、
类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："coc"、
"列"："类别选项组合"、
"valueType"："TEXT"、
类型"： "java.lang.String"java.lang.String"、
"hidden": false、
"meta": false
},
{
"名称"："cocname"、
"列"："类别选项组合名称"、
"valueType"："TEXT"、
类型"： "java.lang.String"java.lang.String"、
"hidden": false、
"meta": false
},
{
"name"："aoc"、
"列"："属性选项组合"、
"valueType"："TEXT"、
类型"： "java.lang.String"java.lang.String"、
"hidden": false、
"meta": false
},
{
"名称"："aocname"、
"列"："属性选项组合名称"、
"valueType"："TEXT"、
类型"： "java.lang.String"java.lang.String"、
"hidden": false、
"meta": false
},
{
"名称"："value"、
"列"：值"、
"valueType"："数值"、
"类型"："java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："mean"、
"列"："平均值"、
"valueType"（值类型）："数值"、
"类型"： "java.lang.Double"java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："stddev"、
"列"："标准偏差"、
"valueType"："数值"、
"类型"： "java.lang.Double"："java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："absdev"、
"列"："绝对偏差"、
"valueType"："数值"、
"类型"： "java.lang.Double"："java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："zscore"、
"列"："zScore"、
"valueType"（值类型）："数值"、
"类型"："java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："lowerbound"、
"列"："下边界"、
"valueType"："数值"、
"类型"： "java.lang.Double"："java.lang.Double"、
"hidden": false、
"meta": false
},
{
"名称"："upperbound"、
"列"："上边界"、
"valueType"："数值"、
"类型"： "java.lang.Double"："java.lang.Double"、
"hidden": false、
"meta": false
}
],
"元数据"：{
"maxResults"：30,
"计数"：3,
"orderBy"："VALUE"、
阈值3.0,
"算法"： "Z_SCORE"："Z_SCORE
},
"rowContext"（行上下文）：{},
宽度18,
"行"：[
[
"DE_22"、
"Q_在 BCG 早期母乳喂养（分娩后 1 小时内）"、
"202209",
"2022 年 9 月"、
"OU_204860"、
"桑达鲁儿童保健中心"、
"/塞拉利昂/凯拉洪/彭圭亚/桑达鲁 CHC"、
"COC_292"、
"固定，<1y"、
"默认"、
"默认"、
"105.0",
"18.3",
"28.7",
"86.7",
"3.0",
"-67.9",
"104.4"
],
[
"DE_359706
"卡介苗剂量
"202208",
"2022 年 8 月"、
"OU_595"、
"恩加鲁 CHC
"/Sierra Leone/Bo/Bargbe/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"，
"耶莫镇 CHC"、
"/Sierra Leone/Bo/Kakua/Yemoh Town CHC"、
"COC_292"、
"固定，<1 年"、
"默认"、
"默认"、
"466.0",
"48.1",
"114.2",
"417.8",
"3.6",
"-294.6",
"391.0"
]
],
"页眉宽度18,
"高度"：3
}
## 分析查询执行计划和成本，包括执行时间估算{ #analytics-query-execution-plan-and-costs-including-execution-time-estimation }
Non-numeric data values encountered during outlier value detection.
- E2209
- Data start date not allowed.
- E2210
**例**
E2211
答复是这样的
``json
{
"headers"：[
{
"name"："dx"、
"列"："数据"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
元": true
},
{
"name"："ou"、
"列"："组织单位"、
"valueType"："TEXT"、
"类型"： "java.lang.String"："java.lang.String"、
"hidden": false、
元": true
},
{
"名称"："value"、
"列"：值"、
"valueType"："数值"、
"类型"："java.lang.Double"、
"hidden": false、
"meta": false
}
],
"元数据"：{
"items"：{
"ImspTQPwCqd"：{
"uid"："ImspTQPwCqd"、
"代码"："OU_525"、
"名称"："塞拉利昂"、
"dimensionItemType"："组织单位"、
"valueType"："数值"、
"totalAggregationType"："SUM"（总和
},
"sB79w2hiLp8"：{
"uid"："sB79w2hiLp8"、
"name"："ANC 3 覆盖范围"、
"description"："按预期孕妇人数分列的第三次产前检查总次数（固定和外展）"、
"legendSet"："fqs276KXCXi"、
"dimensionItemType"："INDICATOR"、
"valueType"："数值"、
"totalAggregationType"："平均值"、
"指标类型"：{
"名称"："百分比"、
"displayName"（显示名称）："百分比"、
"系数"：100,
"数字": false
}
},
"dx"：{
"uid"："dx"、
"name"："数据"、
"dimensionType"："DATA_X
},
"pe"：{
"uid"："pe"、
"名称"："Period"、
"维度类型"："周期"
},
"ou"：{
"uid"："ou"、
"名称"："组织单位"、
"dimensionType"："组织单位"
},
"Uvn6LCg7dVU"：{
"uid"："Uvn6LCg7dVU"、
"代码"："IN_52486"、
"名称"："ANC 1 覆盖范围"、
"描述"："按预期孕妇人数分列的第一次产前检查总次数（固定和外展）"、
"legendSet"："fqs276KXCXi"、
"dimensionItemType"："INDICATOR"、
"valueType"："数值"、
"totalAggregationType"："平均值"、
"指标类型"：{
"名称"："百分比"、
"displayName"（显示名称）："百分比"、
"系数"：100,
"数字": false
}
},
"THIS_YEAR"：{
"名称"："今年"
},
"2022":{
"uid"："2022",
"code"："2022",
"名称"："2022",
"dimensionItemType"："PERIOD"、
"valueType"："数值"、
"totalAggregationType"："SUM"、
"startDate"（开始日期）： "2022-01-01t00:00:00.000"2022-01-01T00:00:00.000",
"endDate"： "2022-12-31t00:00:00.000"2022-12-31T00:00:00.000"
}
},
"维度"：{
"dx"：[
"Uvn6LCg7dVU"、
"sB79w2hiLp8"
],
"pe"：[
"2022"
],
"ou"：[
"ImspTQPwCqd"
],
"co"：[]
}
},
"performanceMetrics"：{
"totalTimeInMillis"：90.894,
"executionPlans"：[
{
"timeInMillis"：12.314,
"planningTime"：6.801,
"执行时间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"、
"策略"："排序"、
"部分模式"："简单"、
"Parallel Aware（并行感知）"： false、
"Async Capable": false、
"启动成本20.21,
"总成本5602.98,
"计划行数"：260,
"平面宽度"：32,
"实际启动时间5.448,
"实际总时间5.449,
"实际行数1,
"实际循环": 11,
"组键"：[
"dx"、
"uidlevel1"
],
"计划"：[
{
"节点类型"位图堆扫描"、
"父节点关系"外部"、
"并行感知"：false
"Async Capable": false、
"关系名称"： false"analytics_2022"、
"别名"："ax"、
"启动成本"：20.21,
"总成本"：5588.33,
"计划行数"：1520,
"平面宽度"：32,
"实际启动时间"：0.446,
"实际总时间"：5.003,
"实际行数1032,
"实际循环": 11,
"重新检查条件"(dx = 'h0xKKjijTdI'::bpchar)"、
"通过索引重新检查删除的行"：0,
"过滤器"： 0"((uidlevel1 = 'ImspTQPwCqd'::bpchar) AND (yearly = '2022'::text) AND (year = 2022))"、
"过滤器删除的行数"：0,
"精确堆块"：46,
"有损堆块"：0,
"计划"：[
{
"节点类型"位图索引扫描"、
"父节点关系"外部"、
"并行感知"：false
"Async Capable": false、
"索引名称"in_dx_ao_ax_2022_MClNI",
"启动成本0.0,
"总成本"： 19.8319.83,
"计划行数"：1520,
"平面宽度"：0,
"实际启动时间"：0.406,
"实际总时间"：0.407,
"实际行数1032,
"实际循环": 11,
"索引条件"："(dx = 'h0xKKjijTdI'::bpchar)"。
}
]
}
]
}
},
{
"timeInMillis"：38.35,
"planningTime"：0.627,
"执行时间"：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"、
"策略"："排序"、
"部分模式"："简单"、
"Parallel Aware（并行感知）"： false、
"Async Capable": false、
"启动成本193.57,
"总成本47322.83,
"计划行数"：261,
"平面宽度"：32,
"实际启动时间"：37.685,
"实际总时间"：37.685,
"实际行数1,
"实际循环": 11,
"组键"：[
"dx"、
"uidlevel1"
],
"计划"：[
{
"节点类型"位图堆扫描"、
"父节点关系"外部"、
"并行感知"：false
"Async Capable": false、
"关系名称"： false"analytics_2022"、
"别名"："ax"、
"启动成本"：193.57,
"总成本"：47191.38,
"计划行数"：17179,
"平面宽度"：32,
"实际启动时间"：1.981,
"实际总时间"：32.332,
"实际行数17462,
"实际循环"：1,
"重新检查条件"(dx = 'Jtf34kNZhzP'::bpchar)"、
"通过索引重新检查删除的行"：0,
"过滤器"： 0"((uidlevel1 = 'ImspTQPwCqd'::bpchar) AND (yearly = '2022'::text) AND (year = 2022))"、
"过滤器删除的行数"：0,
"精确堆块"：1165,
"有损堆块"：0,
"计划"：[
{
"节点类型"位图索引扫描"、
"父节点关系"外部"、
"并行感知"：false
"Async Capable": false、
"索引名称"in_dx_ax_2022_Eb64F",
"启动成本0.0,
"总成本"： 189.27189.27,
"计划行数"：17179,
"平面宽度"：0,
"实际启动时间"：1.765,
"实际总时间"：1.765,
"实际行数17462,
"实际循环"：1,
"索引条件"："(dx = 'Jtf34kNZhzP'::bpchar)"。
}
]
}
]
}
}
]
},
"宽度"：0,
"行"：[],
"高度"：0,
"页眉宽度"：2
}
{
"httpStatus": "Conflict",
"httpStatusCode": 409,
"status": "ERROR",
"message": "Start date and end date or relative period must be specified",
"errorCode": "E2201"
}