API V1 - Perforations

Perforations Endpoint

https://api.welldatalabs.com/perforations/{JobId}

Perforation Object

Here is the shape of the Perforation object.

{
    "jobId": <Well Data Labs unique id for this job>
    "wellName": <well name for this job>
    "api": <api number for this job>
    "stageNumber": <stage number for this job>
    "name": <name of the perforation>
    "ordinal": <ordinal value of the perforation>
    "topMeasuredDepth": <top measured depth for this perforation>
    "bottomMeasuredDepth": <bottom measured depth for this perforation>
    "depthUnit": <unit of measured depth>
    "clusters": <cluster count for perforation>
    "shotDensity": <shot density for perforation>
    "shotDensityUnit": <unit of shot density for perforation>
    "shotCount": <shot count for perforation>
    "phasing": <phasing for perforation>
    "perforationCompany": <perforation company>
    "gunSize": <gun size for perforation>
    "gunSizeUnit": <unit of gun size for perforation>
    "conveyanceMethod": <conveyance method for perforation>
    "chargeType": <charge type for perforation>
    "chargeSize": <charge size for perforation>
    "chargeSizeUnit": <unit of charge size perforation>
    "penetration": <penetration for perforation>
    "penetrationUnit": <unit of penetration for perforation>
    "estimatedHoleDiameter": <estimated hole diameter for perforation>
    "estimatedHoleDiameterUnit": <unit of estimated hole diameter for perforation>
}

Here is a fully populated Perforation object.

{
    "jobId": "6559af2b-5e0f-4765-8c2d-10eeb9150e45",
    "wellName": "Sample Plug-and-Perf",
    "api": "00-000-00000-00-01",
    "stageNumber": 1,
    "name": "Perfs",
    "ordinal": 1,
    "topMeasuredDepth": null,
    "bottomMeasuredDepth": null,
    "depthUnit": null,
    "clusters": 1,
    "shotDensity": 4,
    "shotDensityUnit": "shotsperfoot",
    "shotCount": null,
    "phasing": 60,
    "perforationCompany": "Test Company",
    "gunSize": 3.5,
    "gunSizeUnit": "inches",
    "conveyanceMethod": "Wireline",
    "chargeType": "Shaped Charge",
    "chargeSize": 34,
    "chargeSizeUnit": "g",
    "penetration": 17.3,
    "penetrationUnit": "inches",
    "estimatedHoleDiameter": 0.38,
    "estimatedHoleDiameterUnit": "inches"
}

HTTP Response Status Codes

Status Code Description
200 Successful request and data was returned in the body
400 JobId not valid or missing.
404 No results found. Note that the endpoint was found, we just didn't find any data matching the criteria.
500 Unexpected error

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

A GET request that includes JobId will return an array of Perforation objects that match the given JobId.

curl https://api.welldatalabs.com/perforations/6559af2b-5e0f-4765-8c2d-10eeb9150e45 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

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

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

curl https://api.welldatalabs.com/perforations?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/perforations/6559af2b-5e0f-4765-8c2d-10eeb9150e45?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Stage Number 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.