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. Using the REST APIs
  3. Common API Parameters
  4. Overview of Commonly Used API Parameters
  • Version 2024
  • Version 2023
  • Release Notes
  • Overview
  • Pricing and Billing
  • Deployment
  • Migrate Data
  • Sending Data to Amazon S3
  • Proficy Authentication
  • Data Collectors
  • Using Configuration Hub
  • Using the REST APIs
    • Overview
    • Get an Authorization Token
    • 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
    • Managing Tags
    • Managing Tag Data

      This topic provides REST APIs that you can use to manage tags. You can add, access, modify, rename, and delete tags.

    • Managing Collector Instances
    • Managing Collectors
    • Managing Data Stores
    • Managing Systems
    • 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.

  • Using The Excel Add-In for Historian
  • Using the OLE DB Provider
  • Using Historian Administrator
  • Remote Collector Management
  • Historian Advanced Topics
  • Monitoring
  • Troubleshooting

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