GE Vernova
Historian 9.0
© 2025 GE Vernova and/or its affiliates. All rights reserved. | Privacy | Terms | Cookies
  • Copyright GE Digital
  • Release Notes - Historian 9.0
  • Getting Started Guide
  • Configuration Hub
  • Remote Collector Management
  • Using Historian Administrator

    is a user interface that permits you to monitor, supervise, archive, retrieve and control data gathering. Learn more...

  • Historian Advanced Topics

    This topic contains advanced content on the typical flow of data in a Historian system. Learn more...

  • Historian Alarms and Events

    Historian includes alarms and events data archiving, to provide the ability to retrieve and store alarms and events Data from any OPC-compliant server through the . Learn more...

  • The OPC Classic Alarms and Events Collector
  • Historian REST APIs

    You can use REST APIs for setting up your development environment and for getting started with the Historian services and their associated APIs. Learn more...

    • Introduction to Historian 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
  • Historian System API

    The help in the development of C and C++ programs that interact with Historian at the level. Learn more...

  • Historian User API

    The Historian User API provides high speed read/write access to Historian data and read access to Historian tags. Learn more...

  • Historian SDK

    The Historian Software Development Kit (SDK) is a COM object designed to simplify access to Historian services and data for the purposes of application development. Learn more...

  • Collector Tool Kit

    The Collector Tool kit lets you write programs that integrate tightly with Historian and lets you leverage the configuration tools, redundancy schemes, and health monitoring as collectors that ship with Historian. Learn more...

  • Data Collectors - General

    The Historian Data Collectors General provides descriptive information and specific operating procedures for installing, using and maintaining data collectors. Learn more...

  • The Calculation Collector

    The retrieves data from tags in the Historian archive, performs the calculation, and then stores the resulting values into new archive tags. Learn more...

  • The Cygnet Collector

    The Historian CygNet Data Collector supports collecting of Analog, Digital and String type of data from CygNet Server. Learn more...

  • File Collector

    With , you can import CSV and XML text files into Historian. The is a very useful tool for bringing 3rd party data into Historian. Learn more...

  • iFix Data Collector

    The iFIX Data Collectors use the Easy Data Access (EDA) protocol to retrieve data from a running iFIX system. Learn more...

  • Migrating iFix Data

    The iFIX migration tool enable you to migrate the Classic/Advanced Historian systems and data to Historian. Learn more...

  • MQTT Collector

  • ODBC Collector

    The ODBC Data Collector gathers data samples from a ODBC driver based Source application and stores the corresponding data entries in the Historian Server.

  • OPC DA Collector

    The OPC Collector collects data from any OPC compliant OPC Server. The OPC Collector automatically determines the capability of the OPC Server to which it is connected. Learn more...

  • OPC HDA Collector

    The collects data from any OPC HDA 1.2 -compliant . The automatically determines the capability of the OPC HDA Server to which it is connected. Learn more...

  • OPC Classic HDA Server
  • OPC UA HDA Server
  • OPC UA DA Collector

    The OPC UA DA Collector gathers and collects data from any OPCUA 1.0-compliant OPC UA DA server. The OPC UA DA Collector automatically determines the capability of the OPC UA DA server to which it is connected. Learn more...

  • OSI PI Collector

    The Historian OSI PI Collector gathers data samples from an OSI PI data server and stores the corresponding data entries in the Historian Server or Predix Cloud. Learn more...

  • OSI PI Distributor

    The Historian OSI PI Distributor gathers data from Historian, and writes it to an OSI PI data server. Data can be written directly to the OSI PI Data Archive via the OSI PI data server. Learn more...

  • The Server-to-Server Collector
  • The Server-to-Server Distributor
  • Simulation Data Collector

    The Simulation Collector generates random scaled values and string patterns. The Simulation Collector supports browsing and adding of tags same as the iFIX and the OPC Collectors. Learn more...

  • Windows Performance Collector

    The Windows Performance Collector collects Windows performance counter data and sends it to the Historian server for archival. Learn more...

  • Wonderware Data Collector

    The Wonderware Data Collector gathers data samples from a Wonderware Historian Server application and stores the corresponding data entries in the GE Historian Server. Learn more...

  • OLE DB Provider

    The Historian is a data access mechanism that allows Historian data to be directly queried using Structured Query Language (SQL) statements. Learn more...

  • Using the Historian Excel Add-In

    The Historian Excel Add-In greatly expands the power and benefits of using the Historian data archiving and retrieval system. Learn more...

  • Excel Addin for Operations Hub

  • Historian Trend Client

    is designed to offer a simple and intuitive interface into your process and equipment data through the use of trend charts and current value tables. Learn more...

  • Historian Web Admin Console

    Know how to configure and use the Historian that is included with your Historian product. The Historian includes a diagnostic dashboard and a . Learn more...

  • Extract, Transform, and Load (ETL)
  1. Home
  2. Historian REST APIs

    You can use REST APIs for setting up your development environment and for getting started with the Historian services and their associated APIs. Learn more...

  3. Common API Parameters
  4. Overview of Commonly Used API Parameters
Expand display
Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your Proficy sales agent or e-mail Proficy Sales Support. For the most up-to-date documentation, go here.

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