GE Vernova
Historian 8.0
Copyright © 2025 GE Vernova and/or its affiliates. All rights reserved. | Privacy | Terms | Cookies
  • 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
  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