Jump to main content
https://www.gevernova.com/
            Products         Documentation          Support
×

Supercharge your Proficy solution!  Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2025 releases!

  1. Home
  2. Historian REST APIs
  3. Common API Parameters
  4. Overview of Commonly Used API Parameters
  • Version 2025
  • Version 2024
  • Version 2023
  • Version 2022
  • Version 9.1
  • Version 9.0
  • Version 8.1
  • Version 8.0
  • Version 7.2
  • Release Notes
  • Getting Started Guide
  • Configuration Hub
  • Remote Collector Management
  • Using Historian Administrator
  • Historian Advanced Topics
  • Historian Alarms and Events
  • Historian REST APIs
    • Introduction to Historian REST APIs
    • Common API Parameters
      • Overview of Commonly Used API Parameters
      • TagNames Parameter
      • Start and End Timestamps Parameter
      • TagSamples Parameter
      • DataSample Parameter
      • SamplingModeType Parameter
      • Direction Parameter
      • CalculationModeType Parameter
      • FilterModeType Parameter
      • ReturnDataFields Parameter
      • Payload Parameter

        This parameter queries for the tag properties requested from the server.

      • Error Code Definitions
    • Historian REST APIs
    • Swagger Documentation

      You can now access Historian REST APIs using Swagger UI. This tool enables you to visualize and interact with the API’s resources without having any of the implementation logic in place establishing a fully interactive documentation experience using Swagger.

  • Historian System API
  • Historian User API
  • Historian SDK
  • Historian Utility Suite
  • Collector Tool Kit
  • Data Collectors - General
  • The Calculation Collector
  • The CygNet Collector
  • The File Collector
  • The HAB Collector
  • iFIX Collector
  • Migrating iFix Data
  • The MQTT Collector
  • The MQTT Sparkplug B Collector
  • The ODBC Collector
  • The OPC Classic DA Collector
  • The OPC Classic HDA Collector
  • The OPC Classic Alarms and Events Collector
  • OPC Classic HDA Server
  • OPC UA HDA Server
  • The OPC UA DA Collector
  • OSI PI Collector
  • OSI PI Distributor
  • The Python Collector
  • Server-to-Server Collector
  • The Server-to-Server Distributor
  • The Simulation Collector
  • Windows Performance Collector
  • The Wonderware Collector
  • OLE DB Provider
  • The Excel Add-In for Historian
  • The Excel Addin for Operations Hub
  • Trend Client
  • Historian Web Admin Console
  • Extract, Transform, and Load (ETL)

Overview of Commonly Used API Parameters

The Historian REST service provides various REST API calls to retrieve the current tags list and query data with different sampling modes. Most of these API calls use the following common parameters:

  • tagNames
  • Start and End timestamps
  • TagSamples
  • DataSamples
  • SamplingModeType
  • Direction
  • CalculationModeType
  • FilterModeType
  • ReturnDataFields
  • Payload
  • Error Code Definitions

        © 2025 GE Vernova and/or its affiliates. All rights reserved.            Privacy      Terms      Cookies       Accessibility       

GE Vernova on LinkedIn GE Vernova on X GE Vernova on Facebook GE Vernova on YouTube