# Batch query compensation metric

Batch query compensation metric

## Request

Facts | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/compensation/v1/indicators
HTTP Method | GET
Rate Limit | [10 per second](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
Supported app types | Custom App
Required scopes<br>**To use this API, you must have at least 1 of the listed scopes.** | Get compensation statistical indicator of basic salary(corehr:compensation_indicator:read)

### Request header

Parameter | Type | Required | Description
---|---|---|---
Authorization | string | Yes | `tenant_access_token`<br>**Value format**: "Bearer `access_token`"<br>**Example value**: "Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[How to choose and get access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### Query parameters

Parameter | Type | Required | Description
---|---|---|---
page_size | int | Yes | paging size<br>**Example value**: 100<br>**Default value**: `100`<br>**Data validation rules**:<br>- Value range: `1` ～ `500`
page_token | string | No | Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups<br>**Example value**: 123423321

## Response

### Response body

Parameter | Type | Description
---|---|---
code | int | Error codes, fail if not zero
msg | string | Error descriptions
data | \- | \-
items | indicator\[\] | List of salary statistics indicators
id | string | Salary Statistics Indicator ID
name | string | Salary statistics indicator name
value_type | string | Payroll Statistics Indicators Numerical Types<br>**Optional values are**:<br>- money：amount<br>- number：value<br>- percent：percentage
active_status | int | enabled state<br>**Optional values are**:<br>- 1：enable<br>- 0：disable
i18n_names | i18n_content\[\] | multilingual name
locale | string | language version, eg: "zh-CN", "en-US"
value | string | language name
page_token | string | Page identifier, when has_more is true, a new page_token will also be returned. Otherwise, page_token will not be returned
has_more | boolean | Whether the response body has more parameters

### Response body example
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7196951947228589113",
                "name": "年度现金总和",
                "value_type": "money",
                "active_status": 1,
                "i18n_names": [
                    {
                        "locale": "zh_cn",
                        "value": "中文名称"
                    }
                ]
            }
        ],
        "page_token": "1234452132",
        "has_more": true
    }
}
```

### Error code

HTTP status code | Error code | Description | Troubleshooting suggestions
---|---|---|---
500 | 2290001 | server error | Server level exception
400 | 2290002 | param invalid | Parameter exception
500 | 2290003 | rpc fail | downstream call exception

