Graphql query to retrieve data points

Hi Niranjan,

I understand that you're trying to retrieve data points using GraphQL queries in CDF and encountering some confusion between the dataPoints and getDataPoints methods. Let's address your concerns.

Differences Between dataPoints and getDataPoints

1. Deprecation and Availability:

• The dataPoints method is going to be deprecated soon. It already does not appear in code completion in our query builder in Fusion.

  

   

• The getDataPoints method was introduced to replace dataPoints and align with the timeseries/data/list endpoint.

2. Features and Pagination:

• dataPoints does not offer pagination and is not unit aware, Since it’s response does not match with the timeseries/data/list endpoint, it was not possible to add new features from the timeseries API. Until it’s officially deprecated, it will continue to work, but it won’t get any new features.
• getDataPoints supports pagination and unit conversion, making it a more robust and future-proof option. New features from the timeseries API should be added to this method.

Using getDataPoints Effectively

The getDataPoints method includes some new arguments that are not available in dataPoints, such as first and after, which handle pagination as per GraphQL specifications. Here’s a explanation of the arguments:

• first: Equivalent to the limit argument in the dataPoints method. It specifies the number of data points to retrieve.
• after: Equivalent to the cursor in the timeseries/data/list endpoint. It helps in fetching the next set of data points for pagination.

Here's an example of how to use the getDataPoints method with these arguments:

query MyQuery {
  listProductionData(
    filter: {externalId: {in: ["wellbore1"]}}
  ) {
    items {
      space
      data {
        Oil {
          1_day {
            getDataPoints(first: 100000, start: 1672338600000, end: 2240591400000) {
              unitExternalId
              items {
                timestamp
                value
              }
              pageInfo {
                hasNextPage
                endCursor
              }
            }
          }
        }
      }
    }
  }
}

Example Response and Pagination

The response will include a pageInfo section, which provides information about pagination:

{
  "data": {
    "listProductionData": {
      "items": [
        {
          "space": "some_space",
          "data": {
            "Oil": {
              "1_day": {
                "getDataPoints": {
                  "unitExternalId": "pressure:pa",
                  "items": [
                    {
                      "timestamp": "2023-01-01T00:00:00Z",
                      "value": 8577543.04019
                    },
                    // additional data points
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "endCursor": "Nd3t3/SiQkA="
                  }
                }
              }
            }
          }
        }
      ]
    }
  }
}

To fetch the next set of data points, use the endCursor value from the response in the after argument:

query MyQuery {
  listProductionData(
    filter: {externalId: {in: ["wellbore1"]}}
  ) {
    items {
      space
      data {
        Oil {
          1_day {
            getDataPoints(first: 100000, start: 1672338600000, end: 2240591400000, after: "Nd3t3/SiQkA=") {
              items {
                timestamp
                value
              }
              pageInfo {
                hasNextPage
                endCursor
              }
            }
          }
        }
      }
    }
  }
}

Summary

• Avoid using dataPoints: It will be deprecated soon, lacks pagination, and is not unit aware.
• Use getDataPoints: It supports pagination, unit conversion, and aligns with the latest API specifications.

We recognize that the current documentation is not ideal, and we will be working to improve it. In the meantime, you can refer to this example query with unit conversion for more details.