指标数据接口 - 接口文档

请求参数

Query 参数

stat_period

string

可选

统计期，可选参数，用来限定获取特定指标还是全部指标；传入参数‘all’表示选择全部数据。(月度：202212；季度2022Q4；年度 2023)

示例值:

all

maxRows

string

必需

分页大小，可自行设置

示例值:

1

offset

string

必需

分页偏移量,起始为0

示例值:

0

org_id

string

可选

机构编号，可选参数，用来限定获取特定指标还是全部指标；传入参数‘999999999’表示选择全部数据。

示例值:

999999999

index_code

string

指标编号，必选参数

必需

示例值:

IND000014

stat_freq

string

可选

统计频度，可选参数，用来限定获取特定指标还是全部指标；传入参数‘all’表示选择全部数据。(eg:统计频度：00-每日；01-月度；02-季度；03-年度)

示例值:

all

maintenance_type

string

维护方式

可选

示例值:

all

index_unit

string

指标计量单位

可选

示例值:

all

index_source

string

指标来源

可选

示例值:

all

index_remark

string

指标备注

可选

示例值:

all

reserved_dim1

string

预留维度1

可选

示例值:

all

reserved_dim2

string

预留维度2

可选

示例值:

all

Header 参数

token

string

必需

示例值:

d38ada802a25838ce0a27c6559aa67ef62ba6eb692b7f65ddd7d5f7d2a7d921ca5bcafdad0aaeb43d8915fd641116604a3b251fd76cbbefed08f234998b5f7ac

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://58.251.31.210:28144/index/api?stat_period=all&maxRows=1&offset=0&org_id=999999999&index_code=IND000014&stat_freq=all&maintenance_type=all&index_unit=all&index_source=all&index_remark=all&reserved_dim1=all&reserved_dim2=all' \
--header 'token: d38ada802a25838ce0a27c6559aa67ef62ba6eb692b7f65ddd7d5f7d2a7d921ca5bcafdad0aaeb43d8915fd641116604a3b251fd76cbbefed08f234998b5f7ac'

返回响应

🟢200成功

application/json

Body

code

integer

响应编码

必需

200为成功

message

string

响应信息

必需

成功时显示“success”

success

boolean

响应成功标志

必需

成功时显示“true”

data

object

响应数据

必需

valueSize

integer

返回数据大小

必需

代表此次请求返回的数据大小，单位是byte

value

array [object {12}]

返回值

必需

columnNames

array[string]

必需

示例

{
    "code": 200,
    "message": "success",
    "success": true,
    "data": {
        "valueSize": 105,
        "value": [
            {
                "stat_period": "2021Q2",
                "index_remark": "单位：亿元",
                "org_id": "0",
                "index_value": "71.81149",
                "index_source": "经营拓展大数据系统",
                "total_num": "238",
                "maintenance_type": "1",
                "index_unit": "亿元",
                "index_code": "IND000014",
                "stat_freq": "02",
                "org_name": "****",
                "index_name": "各类型拓展合同额"
            }
        ],
        "columnNames": [
            "maintenance_type",
            "index_code",
            "index_name",
            "stat_freq",
            "stat_period",
            "org_id",
            "org_name",
            "index_value",
            "index_unit",
            "index_source",
            "index_remark",
            "total_num"
        ]
    }
}