Website logo
⌘K
Product
Getting Started
Supported Browsers
ProdX
Drilling
Single Sign-On (SSO)
Developer Docs
API Quick Start Tutorials
Data Schema Fundamentals
API Reference
API Performance Expectations
Data Schema
Modeling
Support
Legal
Docs powered by Archbee
Developer Docs
API Quick Start Tutorials

GraphQL Tutorial

Author(s): Kyle Vessey, December 2022

Developer Prerequisites:

  • mTLS Certificate, Client ID and Client Secret Keys (tutorial)
  • Visual Studio 2022 Community Edition
  • Internet connection

Get the complete source code

Data Schema:

Please read the Data Schema Fundamentals document before using the API.

Visualizing Data:

Data inserted or modified using this tutorial can be visualized using the web portal application(s) at https://tenant.app.onxecta.com. The portal contains a Data Quality Reporting tool where you can see what data is in the system, the validity of the data and when the data was last modified.

Project Setup

Apollo Studio GraphQL Setup

GraphQL Endpoint URL:



The URL for the Xecta GQL endpoint is: https://api.onxecta.com/api/gql

Configure URL

To navigate to Apollo Studio, open your web browser and navigate to https://api.onxecta.com/api/gql

Document image


Generate Bearer Token and Configure Headers

JWT Token

To generate a JWT Token, follow the steps in the Postman Tutorial regarding testing the credentials

Headers

Add a Header with the key name "Authorization" and the value as "Bearer {INSERT JWT TOKEN HERE}"

Document image


Bearer Token:

Make sure to leave a space between the word "Bearer" and the token you paste into this box

Apollo Studio is all set up!

Get Well Information

For many of the GraphQL requests, you will need to run a query to get the XID's for the wells which you want to interact with.

XID

An XID is a Xecta UUID which is used to identify unique entries in the system

GraphQL
query GetWellInfo {
  wells2 {
    xid
    uwi
    sourceId
    name
  }
}


Paste this query into Apollo Studio and click the "GetWellInfo" execution button

Document image


This will return all of the data in the database in the response section on the right.

Well Performance Query

Well Performance:

To learn more about our Well Performance features, read the following documentation:

Well Performance

Well Performance Query Parameters

Field

Description

xid

Unique row identifier for a particular well

name

Well Name

dates

Dates for particular record

timeOn

Time on Production (excludes shut-in periods)

prodIndex

Productivity Index

cumOil

Cumulative Oil

cumWater

Cumulative Water

cumGas

Cumulative Gas

bhp

Bottom Hole Pressure

ddv

Dynamic Drainage Volume

irr

Instantaneous Recovery Ratio

avgResPressure

Average Reservoir Pressure

oilRate

Oil Rate

gasRate

Gas Rate

waterRate

Water Rate

drawdown

Drawdown

GraphQL
query WellPerformance($startDate: ISO8601DateTime!, $endDate: ISO8601DateTime!, $xids: [UUID]!) {
  wells2(wellsCriteria: {xids: $xids}) {
    xid
    name
    wellPerformance(timeAgg: {timeRange: {start: $startDate, end: $endDate}}) {
      dates
      timeOn
      prodIndex
      cumOil
      cumWater
      cumGas
      bhp
      ddv
      irr
      avgResPressure
      oilRate
      gasRate
      waterRate
      drawdown
    }
  }
}


Paste the above query into Apollo Studio

Document image


For this query, you will have to add Variables as well for the startDate, endDate, and a list of XIDs that you want to fetch the Well Performance information for

At the bottom of the Apollo Studio, click the "Variables" tab, and paste in the following code. Make sure the startDate and endDate are ISO8601 complaint dates as well.

XIDs

XIDs are unique identifiers for your particular wells. In order to grab these XIDs, follow the [tutorial above](https://docs.onxecta.com/docs/graphql-tutorial#get-well-information) and paste them as a comma separated list

Variables
{
  "startDate": "2000-01-01T06:00:00.000Z",
  "endDate": "2023-03-08T06:00:00.000Z",
  "xids": [
      "YOUR_XID",
      "YOUR_XID"
  ]
}


Press the blue "WellPerformance" Execution button. You will see your results for your listed wells on the right

Document image


Helpful Tip: Change Response Views

You can change from a JSON to Tabular view by switching between the icons below



Document image


Production Forecast Query

The following tutorials will allow you to call our GraphQL endpoints to pull Production Forecasts

Production Forecast Query Parameters

Field

Description

timeOn

Time on Production (excludes shut-in periods)

date

Date of forecast

oilRate

Oil Rate

gasRate

Gas Rate

waterRate

Water Rate

cumulativeOil

Cumulative Oil

cumulativeWater

Cumulative Water

cumulativeGas

Cumulative Gas

pwf

Bottomhole Pressure

GraphQL
query ProductionForecast($timeRange: TimeRangeInput, $xids: [UUID]!) {
  wells2(wellsCriteria: {xids: $xids}) {
    productionForecast(timeRange: $timeRange) {
      timeOn
      date
      oilRate
      gasRate
      waterRate
      cumulativeOil
      cumulativeWater
      cumulativeGas
      pwf
    }
  }
}


Paste the above query into Apollo Studio

Document image


For this query, add the following variables in the Variables tab at the bottom of the page. Be sure to include whichever start and end date range you are trying to view in ISO8610 format

Variables
{
  "timeRange": {
    "start": "2022-10-28T06:00:00.000Z",
    "end": "2023-04-28T06:00:00.000Z"
  },
  "xids": [
    "YOUR XID"
  ]
}


Click the blue "ProductionForecast" execution button to view the results for the selected XIDs



Document image


Anomaly Detection Query

The following tutorials will allow you to call our GraphQL endpoints to pull Anomalies

Anomaly Detection Query Parameters

Field

Description

uwi

Unique Well Identifier

name

Name of the Anomaly

anomalyType

Type of Anomaly

description

Long description of the Anomaly

actionable

Boolean - Is the Anomaly Actionable or Not

severity

Severity of Anomaly (High / Medium / Low)

timeObserved

Time in which the Anomaly was Observed

GraphQL
query Anomalies($timeRange: TimeRangeInput) {
  wells2 {
    uwi
    anomalies(timeRange: $timeRange) {
      name
      anomalyType
      description
      actionable
      severity
      timeObserved
    }
  }
}


For this query, add the following variables in the Variables tab at the bottom of the page. Be sure to include whichever start and end date range you are trying to view in ISO8610 format

Variables
{
  "timeRange": {
    "end": "2023-06-05T11:27:03-05:00",
    "start": "2023-01-05T11:27:03-05:00"
  }
}


Data Quality Report

Data Quality Report:

To learn more about our Data Quality Report, read the following documentation:

Data Quality Reporting

The following tutorials will allow you to call our GraphQL endpoints to demonstrate how we display data via our user interface.

Data Quality Report - All Wells

GraphQL
 query{  
  wells {
    xid  
    uwi
    sourceId
    name
    wellbores {
    name
    casingCount
    tubingCount
    formationCount
    deviationSurveyCount
    junctionMd
    updatedAt   
   }
    dataQualityReport {            
      variableName
      topic
      description
      errorType
      severity
    }
  }  
}


Data Quality Report - Single Well

GraphQL
 query ProductionGetWell($xid: ID!) {
  well(xid:"c555bc70-2397-4a93-a6eb-cb8477615555") {
    xid  
    uwi
    sourceId
    name
    wellbores {
    name
    casingCount
    tubingCount
    formationCount
    deviationSurveyCount
    junctionMd
    updatedAt   
   }
    dataQualityReport {            
      variableName
      topic
      description
      errorType
      severity
    }
  }  
}


Data Quality Report - Multiple Selected Wells

To select multiple specific wells, you can enter multiple comma separated XID's

GraphQL
query{  
  wells(xids:["3333d397-ad0e-45b8-91ce-441737213333","4444ed8d-6739-4528-91de-1ca98b24444"]) {
    xid  
    uwi
    sourceId
    name
    wellbores {
    name
    casingCount
    tubingCount
    formationCount
    deviationSurveyCount
    junctionMd
    updatedAt   
   }
    dataQualityReport {            
      variableName
      topic
      description
      errorType
      severity
    }
  }  
}




Updated 05 Jun 2023
Did this page help you?
PREVIOUS
Azure Data Factory Tutorial
NEXT
Data Schema Fundamentals
Docs powered by Archbee
TABLE OF CONTENTS
Project Setup
Apollo Studio GraphQL Setup
Configure URL
Generate Bearer Token and Configure Headers
JWT Token
Headers
Get Well Information
Well Performance Query
Well Performance Query Parameters
Production Forecast Query
Production Forecast Query Parameters
Anomaly Detection Query
Anomaly Detection Query Parameters
Data Quality Report
Data Quality Report - All Wells
Data Quality Report - Single Well
Data Quality Report - Multiple Selected Wells
Docs powered by Archbee