[comment]: # ({ad84ea6b-ad84ea6b})
# history.get

[comment]: # ({/ad84ea6b-ad84ea6b})

[comment]: # ({e154f335-385acf3d})
### Description

`integer/array history.get(object parameters)`

Cette méthode permet de récupérer les données d’historique selon les
paramètres fournis.

::: noteimportant
Cette méthode peut renvoyer des données historiques d’une
entité supprimée si ces données n’ont pas encore été supprimées par le housekeeper.
:::

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations
d’appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

[comment]: # ({/e154f335-385acf3d})

[comment]: # ({be708244-ddac6e9c})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|history|integer|Types d'objets d'historique à retourner.<br><br>Valeurs possibles :<br>0 - flottant numérique;<br>1 - caractère;<br>2 - journal;<br>3 - *(par défaut)* entier non signé numérique;<br>4 - texte;<br>5 - binaire.|
|hostids|ID/array|Retourner uniquement l'historique des hôtes donnés.|
|itemids|ID/array|Retourner uniquement l'historique des éléments donnés.|
|time\_from|timestamp|Retourner uniquement les valeurs reçues après ou à l'heure donnée.|
|time\_till|timestamp|Retourner uniquement les valeurs reçues avant ou à l'heure donnée.|
|sortfield|string/array|Trier le résultat selon les propriétés données.<br><br>Valeurs possibles : `itemid`, `clock`, `ns`.|
|search|object|Retourner les résultats correspondant au motif donné (insensible à la casse).<br><br>Accepte un objet, où les clés sont des noms de propriétés et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est fournie, cela effectuera une recherche `LIKE "%…%"`.<br><br>Ne prend pas en charge la recherche par `value` si `history` est défini sur `6` (JSON).|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/be708244-ddac6e9c})

[comment]: # ({7223bab1-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({099d0f6d-cf7bb886})
#### Récupération des données d'historique d'un élément

Renvoie les 10 dernières valeurs reçues d'un élément numérique (float).

[Requête](/manual/api#performing-requests) :

```json
{
    "jsonrpc": "2.0",
    "method": "history.get",
    "params": {
        "output": "extend",
        "history": 0,
        "itemids": "23296",
        "sortfield": "clock",
        "sortorder": "DESC",
        "limit": 10
    },
    "id": 1
}
```

Réponse :

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23296",
            "clock": "1351090996",
            "value": "0.085",
            "ns": "563157632"
        },
        {
            "itemid": "23296",
            "clock": "1351090936",
            "value": "0.16",
            "ns": "549216402"
        },
        {
            "itemid": "23296",
            "clock": "1351090876",
            "value": "0.18",
            "ns": "537418114"
        },
        {
            "itemid": "23296",
            "clock": "1351090816",
            "value": "0.21",
            "ns": "522659528"
        },
        {
            "itemid": "23296",
            "clock": "1351090756",
            "value": "0.215",
            "ns": "507809457"
        },
        {
            "itemid": "23296",
            "clock": "1351090696",
            "value": "0.255",
            "ns": "495509699"
        },
        {
            "itemid": "23296",
            "clock": "1351090636",
            "value": "0.36",
            "ns": "477708209"
        },
        {
            "itemid": "23296",
            "clock": "1351090576",
            "value": "0.375",
            "ns": "463251343"
        },
        {
            "itemid": "23296",
            "clock": "1351090516",
            "value": "0.315",
            "ns": "447947017"
        },
        {
            "itemid": "23296",
            "clock": "1351090456",
            "value": "0.275",
            "ns": "435307141"
        }
    ],
    "id": 1
}
```

[comment]: # ({/099d0f6d-cf7bb886})

[comment]: # ({621f421c-621f421c})
### Source

CHistory::get() dans *ui/include/classes/api/services/CHistory.php*.

[comment]: # ({/621f421c-621f421c})