https://api.welldatalabs.com/jobsummaries

JobSummary Object

JobSummary provides job data summarized by stage. It has three properties. JobId is a string value that Well Data Labs uses internally to uniquely identify a job. Columns is an array of ColumnMetadata objects. Rows is an array of strings. The index of a value within a row tells you what column that value is for. The row value index will match the columnIndex property of a ColumnMetadata object.

The first 54 columns of data are static and will always exist in the result with the same name and at the same columnIndex.

Here is the shape of the JobSummary object.

{
    "jobId": <Well Data Labs unique id for this job>
    "columnMetadata": [ array of ColumnMetadata objects ]
    "rowData": [ array of string arrays ]
}

Here is a fully populated JobSummary object.

{
    "jobId": "b332c113-3397-4379-8ab7-302efc3ae949",
    "columnMetadata": [
        {
            "name": "JOB ID",
            "wdlFieldName": "job_id",
            "unitText": null,
            "columnIndex": 0,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "WELL ID",
            "wdlFieldName": "well_id",
            "unitText": null,
            "columnIndex": 1,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "WELL NAME",
            "wdlFieldName": "well_name",
            "unitText": null,
            "columnIndex": 2,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "API",
            "wdlFieldName": "well_api",
            "unitText": null,
            "columnIndex": 3,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "COUNTY",
            "wdlFieldName": "county",
            "unitText": null,
            "columnIndex": 4,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "SERVICE COMPANY",
            "wdlFieldName": "service_company",
            "unitText": null,
            "columnIndex": 5,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "FORMATION",
            "wdlFieldName": "formation",
            "unitText": null,
            "columnIndex": 6,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "ASSET GROUP",
            "wdlFieldName": "asset_group",
            "unitText": null,
            "columnIndex": 7,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "LATERAL LENGTH",
            "wdlFieldName": "lateral_length",
            "unitText": "ft",
            "columnIndex": 8,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "TREATMENT",
            "wdlFieldName": "treatment",
            "unitText": null,
            "columnIndex": 9,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "STAGE NUMBER",
            "wdlFieldName": "stage_number",
            "unitText": null,
            "columnIndex": 10,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "ZONE",
            "wdlFieldName": "interval_number",
            "unitText": null,
            "columnIndex": 11,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "START DATETIME",
            "wdlFieldName": "start_datetime",
            "unitText": "yyyy-MM-ddTHH:mm:ss",
            "columnIndex": 12,
            "dataType": "dateTime",
            "schemaType": "Static"
        },
        {
            "name": "END DATETIME",
            "wdlFieldName": "end_datetime",
            "unitText": "yyyy-MM-ddTHH:mm:ss",
            "columnIndex": 13,
            "dataType": "dateTime",
            "schemaType": "Static"
        },
        {
            "name": "START DATE",
            "wdlFieldName": "start_date",
            "unitText": "yyyy-MM-dd",
            "columnIndex": 14,
            "dataType": "date",
            "schemaType": "Static"
        },
        {
            "name": "START TIME",
            "wdlFieldName": "start_time",
            "unitText": "HH:mm:ss",
            "columnIndex": 15,
            "dataType": "time",
            "schemaType": "Static"
        },
        {
            "name": "END DATE",
            "wdlFieldName": "end_date",
            "unitText": "yyyy-MM-dd",
            "columnIndex": 16,
            "dataType": "date",
            "schemaType": "Static"
        },
        {
            "name": "END TIME",
            "wdlFieldName": "end_time",
            "unitText": "HH:mm:ss",
            "columnIndex": 17,
            "dataType": "time",
            "schemaType": "Static"
        },
        {
            "name": "PUMP TIME",
            "wdlFieldName": "pump_time",
            "unitText": "hh:mm:ss",
            "columnIndex": 18,
            "dataType": "timeduration",
            "schemaType": "Static"
        },
        {
            "name": "INTERSTAGE TIME",
            "wdlFieldName": "interstage_time",
            "unitText": "hh:mm:ss",
            "columnIndex": 19,
            "dataType": "timeduration",
            "schemaType": "Static"
        },
        {
            "name": "SCREENED OUT",
            "wdlFieldName": "is_screen_out",
            "unitText": null,
            "columnIndex": 20,
            "dataType": "boolean",
            "schemaType": "Static"
        },
        {
            "name": "TOTAL STAGE COST",
            "wdlFieldName": "total_stage_cost",
            "unitText": null,
            "columnIndex": 21,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "TRUE VERTICAL DEPTH",
            "wdlFieldName": "true_vertical_depth",
            "unitText": "ft",
            "columnIndex": 22,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "TOP MEASURED DEPTH",
            "wdlFieldName": "top_measured_depth",
            "unitText": "ft",
            "columnIndex": 23,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "BOTTOM MEASURED DEPTH",
            "wdlFieldName": "bottom_measured_depth",
            "unitText": "ft",
            "columnIndex": 24,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG TREATING PRESSURE",
            "wdlFieldName": "avg_treating_pressure",
            "unitText": "psi",
            "columnIndex": 25,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX TREATING PRESSURE",
            "wdlFieldName": "max_treating_pressure",
            "unitText": "psi",
            "columnIndex": 26,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG SURFACE PRESSURE",
            "wdlFieldName": "avg_surface_pressure",
            "unitText": "psi",
            "columnIndex": 27,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX SURFACE PRESSURE",
            "wdlFieldName": "max_surface_pressure",
            "unitText": "psi",
            "columnIndex": 28,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG BOTTOMHOLE PRESSURE",
            "wdlFieldName": "avg_bottomhole_pressure",
            "unitText": "psi",
            "columnIndex": 29,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX BOTTOMHOLE PRESSURE",
            "wdlFieldName": "max_bottomhole_pressure",
            "unitText": "psi",
            "columnIndex": 30,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "BREAKDOWN",
            "wdlFieldName": "breakdown_pressure",
            "unitText": "psi",
            "columnIndex": 31,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "ISIP",
            "wdlFieldName": "isip_pressure",
            "unitText": "psi",
            "columnIndex": 32,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "ISIP5",
            "wdlFieldName": "isip5_pressure",
            "unitText": "psi",
            "columnIndex": 33,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "ISIP10",
            "wdlFieldName": "isip10_pressure",
            "unitText": "psi",
            "columnIndex": 34,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "FRAC GRADIENT",
            "wdlFieldName": "frac_gradient",
            "unitText": "psi/ft",
            "columnIndex": 35,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "HORSEPOWER",
            "wdlFieldName": "horsepower",
            "unitText": "hhp",
            "columnIndex": 36,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG SLURRY RATE",
            "wdlFieldName": "avg_slurry_rate",
            "unitText": "bpm",
            "columnIndex": 37,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX SLURRY RATE",
            "wdlFieldName": "max_slurry_rate",
            "unitText": "bpm",
            "columnIndex": 38,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "CLEAN VOLUME",
            "wdlFieldName": "total_clean_volume",
            "unitText": "bbl",
            "columnIndex": 39,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "SLURRY VOLUME",
            "wdlFieldName": "total_slurry_volume",
            "unitText": "bbl",
            "columnIndex": 40,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "PUMPDOWN VOLUME",
            "wdlFieldName": "pumpdown_volume",
            "unitText": "bbl",
            "columnIndex": 41,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "FLUSH VOLUME",
            "wdlFieldName": "flush_volume",
            "unitText": "bbl",
            "columnIndex": 42,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG PROPPANT CONC",
            "wdlFieldName": "avg_proppant_concentration",
            "unitText": "lbs/gal",
            "columnIndex": 43,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX PROPPANT CONC",
            "wdlFieldName": "max_proppant_concentration",
            "unitText": "lbs/gal",
            "columnIndex": 44,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "AVG BH PROPPANT CONC",
            "wdlFieldName": "avg_bottomhole_proppant_concentration",
            "unitText": "lbs/gal",
            "columnIndex": 45,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "MAX BH PROPPANT CONC",
            "wdlFieldName": "max_bottomhole_proppant_concentration",
            "unitText": "lbs/gal",
            "columnIndex": 46,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "TOTAL PROPPANT",
            "wdlFieldName": "total_proppant",
            "unitText": "lbs",
            "columnIndex": 47,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "FRAC SYSTEM",
            "wdlFieldName": "frac_system",
            "unitText": null,
            "columnIndex": 48,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "FLUID SYSTEM",
            "wdlFieldName": "fluid_system",
            "unitText": null,
            "columnIndex": 49,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "CREW",
            "wdlFieldName": "crew_name",
            "unitText": null,
            "columnIndex": 50,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "ENGINEER",
            "wdlFieldName": "engineer_name",
            "unitText": null,
            "columnIndex": 51,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "WATER SOURCE",
            "wdlFieldName": "water_source",
            "unitText": null,
            "columnIndex": 52,
            "dataType": "string",
            "schemaType": "Static"
        },
        {
            "name": "PROP LOADING",
            "wdlFieldName": "proppant_loading",
            "unitText": "lbs/ft",
            "columnIndex": 53,
            "dataType": "numeric",
            "schemaType": "Static"
        },
        {
            "name": "CROSSLINKER-CROSSLINKER",
            "wdlFieldName": "total_volume",
            "unitText": "gal",
            "columnIndex": 54,
            "dataType": "numeric",
            "schemaType": "Dynamic"
        },
        {
            "name": "CROSSLINKER-CROSSLINKER",
            "wdlFieldName": "volume_concentration",
            "unitText": "gal/mgal",
            "columnIndex": 55,
            "dataType": "numeric",
            "schemaType": "Dynamic"
        },
        {
            "name": "GBW-5-BREAKER",
            "wdlFieldName": "total_volume",
            "unitText": "gal",
            "columnIndex": 56,
            "dataType": "numeric",
            "schemaType": "Dynamic"
        },
        {
            "name": "GBW-5-BREAKER",
            "wdlFieldName": "volume_concentration",
            "unitText": "gal/mgal",
            "columnIndex": 57,
            "dataType": "numeric",
            "schemaType": "Dynamic"
        }
    ],
    "rowData": [
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "JOB TOTAL", null, null, "2015-01-01T12:00:26", "2015-01-01T17:32:50", "2015-01-01", "12:00:26", "2015-01-01", "17:32:50", "05:23:27", "00:01:42", null, null, null, null, null, "4,910", "6,559", "40", "78", "8,147", "10,453", null, null, null, null, null, null, null, null, "23,972", "25,570", null, null, "1.59", "4.60", "1.70", "4.63", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "4.60" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 1", "1.000000", "1", "2015-01-01T12:02:47", "2015-01-01T12:58:35", "2015-01-01", "12:02:47", "2015-01-01", "12:58:35", "00:55:47", "00:00:18", "false", null, null, null, null, "5,552", "6,559", "51", "57", "8,594", "10,453", "4,228", "4,322", null, null, null, null, null, null, "3,998", "4,263", null, null, "1.56", "4.17", "1.68", "4.20", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "5.70" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 2", "2.000000", "2", "2015-01-01T12:58:53", "2015-01-01T13:54:24", "2015-01-01", "12:58:53", "2015-01-01", "13:54:24", "00:55:30", "00:00:23", "false", null, null, null, null, "5,312", "6,370", "49", "78", "8,440", "10,258", null, null, null, null, null, null, null, null, "3,996", "4,267", null, null, "1.60", "4.60", "1.72", "4.63", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "5.80" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 3", "3.000000", "3", "2015-01-01T13:54:47", "2015-01-01T14:50:24", "2015-01-01", "13:54:47", "2015-01-01", "14:50:24", "00:55:36", "00:00:16", "false", null, null, null, null, "4,647", "5,754", "39", "43", "7,852", "9,624", null, null, null, null, null, null, null, null, "4,018", "4,288", null, null, "1.59", "4.30", "1.72", "4.33", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "4.20" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 4", "4.000000", "4", "2015-01-01T14:50:40", "2015-01-01T15:45:39", "2015-01-01", "14:50:40", "2015-01-01", "15:45:39", "00:54:58", "00:00:23", "false", null, null, null, null, "4,396", "5,898", "36", "40", "7,682", "9,788", null, null, null, null, null, null, null, null, "4,007", "4,274", null, null, "1.59", "4.27", "1.72", "4.30", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "4.50" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 5", "5.000000", "5", "2015-01-01T15:46:02", "2015-01-01T16:38:55", "2015-01-01", "15:46:02", "2015-01-01", "16:38:55", "00:52:52", "00:00:22", "false", null, null, null, null, "4,618", "6,131", "34", "37", "7,973", "10,037", null, null, null, null, null, null, null, null, "4,011", "4,272", null, null, "1.52", "4.19", "1.66", "4.23", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "4.00" ],
            [ "b332c113-3397-4379-8ab7-302efc3ae949", "8d206684-e725-44ca-8235-80ef567804ba", "Sample Ball-and-Sleeve", "05-123-00000-00-00", "Weld", "Demo Service Company", "Sample", "Demo Asset", "4000", "Stage 6", "6.000000", "6", "2015-01-01T16:39:17", "2015-01-01T17:27:57", "2015-01-01", "16:39:17", "2015-01-01", "17:27:57", "00:48:39", "00:00:00", "false", null, null, null, null, "4,911", "5,454", "32", "35", "8,351", "8,727", null, null, null, null, null, null, null, null, "3,940", "4,206", null, null, "1.69", "4.55", "1.72", "4.59", null, "Plug and Perf", "Slickwater", "Fleet 1", "Demo Name", "City", null, null, "0.50", null, "2.80" ]
    ]
}

ColumnMetadata Object

The columns property contains an array of ColumnMetadata objects. ColumnMetadata provides information about a column such as the column name, the unit, the index of the column in the row data, etc.

{
    "name": "PUMP TIME",
    "wdlFieldName": "pump_time",
    "unitText": "hh:mm:ss",
    "columnIndex": 18,
    "dataType": "numeric",
    "schemaType": "Static"
}

Schema Type Property

Every ColumnMetadata object includes a property of "schemaType" as shown above. The columns that are always included in the the JobSummary object and always have the same columnIndex are set to "Static". Any column that might not be in a result or might be in a different columnIndex are set to "Dynamic".

Schema Type Description
Static The first 53 columns are marked with a schemaType of Static. These columns will always exist in the result with the same name and same columnIndex.
Dynamic These columns might not be in a result or might be in a different columnIndex. This data includes all other summary data mapped for the job.

HTTP Response Status Codes

Status Code Description
200 Successful request and data was returned in the body
202 The request was successful but the system is building summary data for the job. This can take a few minutes. Try the request again.
400 JobId or APINumber 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/jobsummaries

A GET request to the base endpoint with no Id parameter will return an array of JobSummary objects for the 10 most recent jobs.

curl https://api.welldatalabs.com/jobsummaries --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="

GET https://api.welldatalabs.com/jobsummaries/{Id},{Id},{Id}

A GET request that includes a list of one or more Id parameters will return an array of JobSummary objects for all jobs that match the given Ids. Each Id can be either a well API Number or a Well Data Labs Job Id or Well Id. If any of the Ids represent the same job, only one instance of the job summary is returned.

Multiple job summaries might be returned for a single well API Number if multiple jobs exist for that well. It's possible to have more than one job (multiple fracs or a refrac) for a single well.

curl https://api.welldatalabs.com/jobsummaries/05-123-00000-00-00 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Id Parameters

Parameter Description
API Number Well API Number; e.g. 05-123-00000-00-00
JobId Well Data Labs assigned Job Id; e.g. b332c113-3397-4379-8ab7-302efc3ae949
WellId Well Data Labs assigned Well Id; e.g. 8d206684-e725-44ca-8235-80ef567804ba

GET https://api.welldatalabs.com/jobsummaries?fromChangeUtc={datetime}&toChangeUtc={datetime}

A GET request to the base endpoint with optional fromChangeUtc and toChangeUtc parameters will return an array of JobSummary objects for the 10 most recent jobs that match the given timeframe.

curl https://api.welldatalabs.com/jobsummaries?fromChangeUtc=2017-11-15T21:19:34&toChangeUtc=2017-11-17T21:19:34 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
Change Date Parameters*

Parameter Description
fromChangeUtc={datetime} Returns results for all jobs with changes greater than or equal to this parameter value.
toChangeUtc={datetime} Returns results for all jobs with changes less than or equal to this parameter value.
fromChangeUtc={datetime}&toChangeUtc={datetime} Returns results for all jobs with changes between and including the fromChangeUtc and toChangeUtc.
*The ChangeUtc parameters include milliseconds. Parameter values will be matched to the millisecond. If not all expected results are returned, increase or decrease the parameter value by one second.

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

A GET request to the base endpoint with optional fromStageNumber and toStageNumber parameters will return an array of JobSummary objects for the 10 most recent jobs and match the given stage numbers.

curl https://api.welldatalabs.com/jobsummaries?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/jobsummaries/05-123-00000-00-00?fromStageNumber=1&toStageNumber=2 --header "Authorization: Bearer b+S15uKWEK0lFU+NomEmvekn8yk/ALTTBAYOJalVKrI="
curl https://api.welldatalabs.com/jobsummaries?fromChangeUtc=2017-11-15T21:19:34&toChangeUtc=2017-11-17T21:19:34&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.