API V1 - PerSecData

PerSecData Endpoint

This is a premium paid feature, please contact sales@welldatalabs.com for more information.
https://api.welldatalabs.com/persecdata/{JobId}

PerSecData Object

Here is the shape of the PerSecData object.

JOB TIME,JOB TIME0,STAGE TIME0,TIME TO ISIP,WELL NAME,API NUMBER,STAGE NUMBER,TREATING PRESSURE,BOTTOMHOLE PRESSURE,ANNULUS PRESSURE,SURFACE PRESSURE,SLURRY RATE,CLEAN VOLUME,SLURRY VOLUME,PROPPANT TOTAL,PROPPANT CONC,BOTTOMHOLE PROPPANT CONC
(datetime),(min),(min),(min),(none),(none),(none),(psi),(psi),(psi),(psi),(bpm),(bbl),(bbl),(lbs),(lbs/gal),(lbs/gal)
06/17/18 04:15:08,0.033333,0.000000,,Sample Ball-and-Sleeve,05-123-00000-00-00,1,-16.310000,0.000000,-8.130000,-0.900000,0.480000,0.000000,7.300000,0.000000,0.000000,0.000000
06/17/18 04:15:09,0.050000,0.016667,,Sample Ball-and-Sleeve,05-123-00000-00-00,1,-16.310000,0.000000,-8.130000,2.710000,0.490000,0.000000,7.310000,0.000000,0.000000,0.000000
06/17/18 04:15:10,0.066667,0.033333,,Sample Ball-and-Sleeve,05-123-00000-00-00,1,-16.010000,0.000000,-8.130000,-0.900000,0.510000,0.000000,7.320000,0.000000,0.000000,0.000000
...

Authentication and Throttling

For access to the PerSecData Endpoint you will need to contact support@welldatalabs.com.

If you receive a 429 response code with the message "You have exceeded your limit of X request per X minute.", then you will need to wait to call the endpoint again. You can see the remaining time until your next execution in the response header under: Retry-After → XX seconds.

HTTP Response Status Codes

Status Code Description
200 Successful request and data was returned in the body
400 JobId not valid or missing.
401 Authentication token is invalid. See Authentication for more details.
403 A valid token was received, but it doesn't have permissions to PerSecData. Contact support@welldatalabs.com for assistance.
404 No results found. Note that the endpoint was found, we just didn't find any data matching the criteria.
429 You have exceeded your limit of X request per X minute.
500 Unexpected error

GET https://api.welldatalabs.com/persecdata/{JobId}

A GET request that includes JobId will return an array of only global field PerSecData objects that match the given JobId.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

GET https://api.welldatalabs.com/persecdata/{JobId}?fromStageNumber={number}&toStageNumber={number}

A GET request to the base endpoint with optional fromStageNumber and toStageNumber parameters will return an array of PerSecData objects that match the given stage numbers.

NOTE: When using curl and combining multiple parameters, ensure that your URL is surrounded by quotation marks ("). On most command line interfaces, ampersand (&) is a special character and will be interpreted as starting a new command.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee?fromStageNumber=1&toStageNumber=2" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

GET https://api.welldatalabs.com/persecdata/{JobId}?includeAllChannels={boolean}

A GET request to the base endpoint with optional includeAllChannels parameter will return all PerSecData objects that match the given JobId. Global field objects will have global field name; other channels will have column name from original import file.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee?includeAllChannels=true" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

NOTE: When using curl and combining multiple parameters, ensure that your URL is surrounded by quotation marks ("). On most command line interfaces, ampersand (&) is a special character and will be interpreted as starting a new command.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee?includeAllChannels=true&toStageNumber=3" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

The PerSecData object will expand the number of columns when includeAllChannels is True.

JOB TIME,JOB TIME0,STAGE TIME0,TIME TO ISIP,WELL NAME,API NUMBER,STAGE NUMBER,TREATING PRESSURE,BOTTOMHOLE PRESSURE,SURFACE PRESSURE,SLURRY RATE,CLEAN VOLUME,SLURRY VOLUME,PROPPANT TOTAL,PROPPANT CONC,BOTTOMHOLE PROPPANT CONC,CLEAN DENSITY,JOB CLEAN VOL,STAGE PROPPANT,GEL PH,TEMP @ SLURRY DENSITY,GEL VISCOSITY,XL CONC,XLDELAY CONC,BIOAG CONC,PHAG CONC,CLAYST CONC,BREAKAG CONC,BREAKCAT CONC,FR CONC,SURFAG CONC,BREAKFR CONC,STAGE AT BLENDER,
(datetime),(min),(min),(min),(none),(none),(none),(psi),(psi),(psi),(bpm),(bbl),(bbl),(lbs),(lbs/gal),(lbs/gal),(lbs/gal),(bbl),(lbs),(ph),(degrees F),(cp),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(gal/mgal),(lbs/gal),(),
08/08/16 14:43:21,145.500000,0.000000,93.666667,Demo Well L,10-203-04050-60-,1,1337.813368,4471.234809,0.000000,0.083488,0.002778,0.002778,0.000000,0.000000,0.000000,8.328953,0.002778,0.000000,8.866211,93.000000,0.647083,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,1.000000,
08/08/16 14:43:22,145.516667,0.016667,93.650000,Demo Well L,10-203-04050-60-,1,1339.523003,4472.961372,0.000000,0.031308,0.003299,0.003299,0.000000,0.000000,0.000000,8.327909,0.003299,0.000000,8.866211,93.000000,0.711700,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,0.000000,1.000000,
...

GET https://api.welldatalabs.com/persecdata/{JobId}?includeInterstageData=true

A GET request to the base endpoint with the optional includeInterstageData parameter will return all rows in the job.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee?includeInterstageData=true" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

A GET request that combines the includeInterstageData parameter with fromStageNumber and toStageNumber will collect all available rows between those stages. If only fromStageNumber is specified, then all rows will be returned starting with the beginning of the specified stage. If only toStageNumber is specified, then all rows will be returned up to the end of the specified stage.

NOTE: When using curl and combining multiple parameters, ensure that your URL is surrounded by quotation marks ("). On most command line interfaces, ampersand (&) is a special character and will be interpreted as starting a new command.

curl "https://api.welldatalabs.com/persecdata/be9b1ff9-34b2-43bb-bf9a-aec7f77770ee?includeInterstageData=true&fromStageNumber=1&toStageNumber=2" --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
All PerSecData Parameters

Parameter Description
fromStageNumber={number} Returns results for all stages greater than or equal to this parameter value.
toStageNumber={number} Returns results for all stages less than or equal to this parameter value.
fromStageNumber={number}&toStageNumber={number} Returns results for all stages between and including the stages fromStageNumber and toStageNumber.
includeAllChannels={boolean} If True, returns all PerSecData objects that match the given job.
includeInterstageData={boolean} If True, returns data between stages. If fromStageNumber is specified, all rows past the start of that stage will be returned. If toStageNumber is specified all rows up to the end of that stage will be returned. If both are specified, then all rows from the start of the fromStageNumber to end of the toStageNumber will be returned.