trend.get

Description

integer/array trend.get(object parameters)

La méthode permet de récupérer des données de tendance en fonction des paramètres donnés.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

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

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

Paramètre Type Description
itemids string/array Renvoie uniquement les tendances avec les ID d'élément donnés.
time_from timestamp Renvoie uniquement les valeurs collectées après ou à l'heure indiquée.
time_till timestamp Renvoie uniquement les valeurs collectées avant ou à l'heure indiquée.
countOutput boolean Compte le nombre d'objets récupérés.
limit integer Limite la quantité d'objets récupérés.
output query Définit les champs à afficher.

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é.

Exemples

 Récupération des données de tendance d'un élément

Requête :

{
    "jsonrpc": "2.0",
    "method": "trend.get",
    "params": {
        "output": [
            "itemid",
            "clock",
            "num",
            "value_min",
            "value_avg",
            "value_max",
        ],
        "itemids": [
            "23715"
        ],
        "limit": "1"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23715",
            "clock": "1446199200",
            "num": "60",
            "value_min": "0.165",
            "value_avg": "0.2168",
            "value_max": "0.35",
        }
    ],
    "id": 1
}

Source

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