{
  "openapi": "3.1.0",
  "info": {
    "title": "Novi Data v3 API",
    "version": "3.0",
    "description": "The v3 REST API returns Novi data as JSON, one endpoint per resource. Choose the dataset with the `scope` parameter, send `application/json` as the Content-Type, and authenticate with a token from `POST /sessions`. Each client IP address can make up to 1,000 requests per hour. v3 and v4 run side by side, and new datasets land in v4: see [Moving from v3](/data/migrate-from-v3/)."
  },
  "servers": [
    {
      "url": "https://insight.novilabs.com/api/v3",
      "description": "Novi Data v3 API"
    }
  ],
  "tags": [
    {
      "name": "Sessions"
    },
    {
      "name": "Basins"
    },
    {
      "name": "Bulk"
    },
    {
      "name": "Bulk diffs"
    },
    {
      "name": "Company acreage"
    },
    {
      "name": "Directional surveys"
    },
    {
      "name": "Forecast segments"
    },
    {
      "name": "Forecast well months"
    },
    {
      "name": "Forecast well years"
    },
    {
      "name": "Forecast wells"
    },
    {
      "name": "FracFocus ingredients"
    },
    {
      "name": "FracFocus summary"
    },
    {
      "name": "Horizontal rig weeks"
    },
    {
      "name": "Organizations"
    },
    {
      "name": "Platforms"
    },
    {
      "name": "Rig and frac details"
    },
    {
      "name": "Structures"
    },
    {
      "name": "Subsurface"
    },
    {
      "name": "Supply projections"
    },
    {
      "name": "Well details"
    },
    {
      "name": "Well forecast months"
    },
    {
      "name": "Well forecasts"
    },
    {
      "name": "Well months"
    },
    {
      "name": "Well permits"
    },
    {
      "name": "Well spacing"
    },
    {
      "name": "Well spacing configuration"
    },
    {
      "name": "Well tests"
    },
    {
      "name": "Wellbore locations"
    },
    {
      "name": "Wells"
    }
  ],
  "paths": {
    "/sessions": {
      "post": {
        "tags": [
          "Sessions"
        ],
        "summary": "Retrieve API authentication token",
        "operationId": "sessionsCreate",
        "security": [],
        "description": "When successfully authenticated, an authentication token is returned for future requests. Add this token as a query parameter (`?authentication_token=`) to every following request, or send it in a custom `authentication-token` header. The token expires one day after it is issued; then retrieve another.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "email",
                  "password"
                ],
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email address"
                  },
                  "password": {
                    "type": "string",
                    "description": "Password"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "An object with the `authentication_token`.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/basins": {
      "get": {
        "tags": [
          "Basins"
        ],
        "summary": "Retrieve paginated basins data",
        "operationId": "basinsIndex",
        "description": "Fetching basins filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/basins.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated basins data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/bulk": {
      "get": {
        "tags": [
          "Bulk"
        ],
        "summary": "Retrieve the last export by ExportDate",
        "operationId": "bulkIndex",
        "description": "Fetching onshore data file for Basin = Permian looks like this: `/api/v3/bulk.json?q[Basin_eq]=Permian&scope=us-onshore`\n\nWeekly snapshots: the last export of each ISO week (Monday to Sunday, UTC) for each Tier, Basin and SubBasin is kept and can be downloaded indefinitely. Other exports are listed for 89 days. The newest weekly snapshot before August 2026 for Basin = Permian (the week ending Sunday, July 26): `/api/v3/bulk.json?q[Basin_eq]=Permian&q[IsWeeklySnapshot_eq]=true&q[ExportDate_lt]=2026-08-01&scope=us-onshore`",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The last export by ExportDate, as a JSON array of objects.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/bulk-diffs": {
      "get": {
        "tags": [
          "Bulk diffs"
        ],
        "summary": "Retrieve the latest updates to the database in the format of diffs which you can apply incrementally to reach the latest version",
        "operationId": "bulkDiffsIndex",
        "description": "Fetching the onshore bulk diff file for Basin = Permian since the export you last applied looks like this: `/api/v3/bulk-diffs.json?q[Basin_eq]=Permian&scope=us-onshore&since=<ExportDate>`\n\nWe recommend downloading the full dataset regularly (for example, weekly) instead of using diffs.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "since",
            "in": "query",
            "description": "ExportDate of the last export you applied. If it is more than 89 days old, the response is 400 with error_code `force_full_download`: download the full export from /bulk instead, as daily exports are listed for 89 days only.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The latest updates to the database in the format of diffs which you can apply incrementally to reach the latest version, as JSON.",
            "content": {
              "application/json": {}
            }
          },
          "400": {
            "description": "Bad request. When `since` is more than 89 days old, the body's `error_code` is `force_full_download`: download the full export from `/bulk` instead, as daily exports are listed for 89 days only.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/company_acreage": {
      "get": {
        "tags": [
          "Company acreage"
        ],
        "summary": "Retrieve paginated company acreage data",
        "operationId": "companyAcreageIndex",
        "description": "Fetching company acreage filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/company_acreage.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated company acreage data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/directional_surveys": {
      "get": {
        "tags": [
          "Directional surveys"
        ],
        "summary": "Retrieve paginated directional surveys data",
        "operationId": "directionalSurveysIndex",
        "description": "Fetching directional surveys filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/directional_surveys.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated directional surveys data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/forecast_segments": {
      "get": {
        "tags": [
          "Forecast segments"
        ],
        "summary": "Retrieve paginated forecast segments data",
        "operationId": "forecastSegmentsIndex",
        "description": "Fetching forecast segments filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/forecast_segments.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated forecast segments data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/forecast_well_months": {
      "get": {
        "tags": [
          "Forecast well months"
        ],
        "summary": "Retrieve paginated forecast well months data",
        "operationId": "forecastWellMonthsIndex",
        "description": "Fetching forecast well months filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/forecast_well_months.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated forecast well months data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/forecast_well_years": {
      "get": {
        "tags": [
          "Forecast well years"
        ],
        "summary": "Retrieve paginated forecast well year data",
        "operationId": "forecastWellYearsIndex",
        "description": "Fetching forecast well years filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/forecast_well_years.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated forecast well year data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/forecast_wells": {
      "get": {
        "tags": [
          "Forecast wells"
        ],
        "summary": "Retrieve paginated forecast wells data",
        "operationId": "forecastWellsIndex",
        "description": "Fetching forecast wells filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/forecast_wells.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated forecast wells data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/frac_focus_ingredients": {
      "get": {
        "tags": [
          "FracFocus ingredients"
        ],
        "summary": "Retrieve paginated FracFocus ingredients data",
        "operationId": "fracFocusIngredientsIndex",
        "description": "Fetching FracFocus ingredients filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/frac_focus_ingredients.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated FracFocus ingredients data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/frac_focus_summary": {
      "get": {
        "tags": [
          "FracFocus summary"
        ],
        "summary": "Retrieve paginated FracFocus summary data",
        "operationId": "fracFocusSummaryIndex",
        "description": "Fetching FracFocus summary filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/frac_focus_summary.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated FracFocus summary data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/horizontal_rig_weeks": {
      "get": {
        "tags": [
          "Horizontal rig weeks"
        ],
        "summary": "Retrieve paginated horizontal rig weeks data",
        "operationId": "horizontalRigWeeksIndex",
        "description": "Fetching horizontal rig weeks filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/horizontal_rig_weeks.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated horizontal rig weeks data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/organizations": {
      "get": {
        "tags": [
          "Organizations"
        ],
        "summary": "Retrieve paginated organizations data",
        "operationId": "organizationsIndex",
        "description": "Fetching organizations filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/organizations.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated organizations data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/platforms": {
      "get": {
        "tags": [
          "Platforms"
        ],
        "summary": "Retrieve paginated platforms data",
        "operationId": "platformsIndex",
        "description": "Fetching platforms filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/platforms.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `gom`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "gom"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated platforms data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/rig_and_frac_details": {
      "get": {
        "tags": [
          "Rig and frac details"
        ],
        "summary": "Retrieve paginated rig and frac details data",
        "operationId": "rigAndFracDetailsIndex",
        "description": "Fetching rig and frac details filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/rig_and_frac_details.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated rig and frac details data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/structures": {
      "get": {
        "tags": [
          "Structures"
        ],
        "summary": "Retrieve paginated structures data",
        "operationId": "structuresIndex",
        "description": "Fetching structures filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/structures.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `gom`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "gom"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated structures data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/subsurface": {
      "get": {
        "tags": [
          "Subsurface"
        ],
        "summary": "Retrieve paginated subsurface data",
        "operationId": "subsurfaceIndex",
        "description": "Fetching subsurface filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/subsurface.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated subsurface data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/supply_projections": {
      "get": {
        "tags": [
          "Supply projections"
        ],
        "summary": "Retrieve paginated supply projections data",
        "operationId": "supplyProjectionsIndex",
        "description": "Fetching supply projections filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/supply_projections.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated supply projections data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_details": {
      "get": {
        "tags": [
          "Well details"
        ],
        "summary": "Retrieve paginated well details data",
        "operationId": "wellDetailsIndex",
        "description": "Fetching well details filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_details.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well details data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_forecast_months": {
      "get": {
        "tags": [
          "Well forecast months"
        ],
        "summary": "Retrieve paginated well forecast months data",
        "operationId": "wellForecastMonthsIndex",
        "description": "Fetching well forecast months filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_forecast_months.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well forecast months data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_forecasts": {
      "get": {
        "tags": [
          "Well forecasts"
        ],
        "summary": "Retrieve paginated well forecasts data",
        "operationId": "wellForecastsIndex",
        "description": "Fetching well forecasts filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_forecasts.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well forecasts data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_months": {
      "get": {
        "tags": [
          "Well months"
        ],
        "summary": "Retrieve paginated well months data",
        "operationId": "wellMonthsIndex",
        "description": "Fetching well months filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_months.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well months data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_permits": {
      "get": {
        "tags": [
          "Well permits"
        ],
        "summary": "Retrieve paginated well permits data",
        "operationId": "wellPermitsIndex",
        "description": "Fetching well permits filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_permits.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well permits data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_spacing": {
      "get": {
        "tags": [
          "Well spacing"
        ],
        "summary": "Retrieve paginated well spacing data",
        "operationId": "wellSpacingIndex",
        "description": "Fetching well spacing filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_spacing.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well spacing data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_spacing_configuration": {
      "get": {
        "tags": [
          "Well spacing configuration"
        ],
        "summary": "Retrieve paginated well spacing configuration data",
        "operationId": "wellSpacingConfigurationIndex",
        "description": "Fetching well spacing configuration filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_spacing_configuration.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well spacing configuration data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/well_tests": {
      "get": {
        "tags": [
          "Well tests"
        ],
        "summary": "Retrieve paginated well tests data",
        "operationId": "wellTestsIndex",
        "description": "Fetching well tests filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/well_tests.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated well tests data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/wellbore_locations": {
      "get": {
        "tags": [
          "Wellbore locations"
        ],
        "summary": "Retrieve paginated wellbore locations data",
        "operationId": "wellboreLocationsIndex",
        "description": "Fetching wellbore locations filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/wellbore_locations.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico) or `us-onshore` (US onshore). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated wellbore locations data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    },
    "/wells": {
      "get": {
        "tags": [
          "Wells"
        ],
        "summary": "Retrieve paginated wells data",
        "operationId": "wellsIndex",
        "description": "Fetching wells filtered by column1 = value1 and column2 = value2 looks like this: `/api/v3/wells.json?q[Column1_eq]=value1&q[column2_eq]=value2`\n\nResults can be rolled up with `agg_function`, `agg_columns`, `agg_group_by_columns` and `join_table`.",
        "parameters": [
          {
            "name": "scope",
            "in": "query",
            "description": "The dataset: `us-horizontals` (US horizontals), `gom` (Gulf of Mexico), `us-onshore` (US onshore) or `canada` (Canada). Defaults to `us-horizontals`.",
            "schema": {
              "type": "string",
              "enum": [
                "us-horizontals",
                "gom",
                "us-onshore",
                "canada"
              ],
              "default": "us-horizontals"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number for pagination",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filter with Ransack matchers, for example `q[Basin_eq]=Permian`. See [Ransack search matchers](https://activerecord-hackery.github.io/ransack/getting-started/search-matches/).",
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object"
            }
          },
          {
            "name": "agg_function",
            "in": "query",
            "description": "Specify the aggregate function: SUM, MAX, MIN, AVG, COUNT or COUNTD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_columns",
            "in": "query",
            "description": "Specify the column name(s) to apply the aggregate function to. For example, OilPerDay, GasPerDay performs SUM(OilPerDay), SUM(GasPerDay) when agg_function is SUM. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "agg_group_by_columns",
            "in": "query",
            "description": "Specify the column name(s) to group the results by, such as Basin, State, County. Column names are case-sensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "join_table",
            "in": "query",
            "description": "Specify the table to join with, for example Wells. Case-sensitive.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated wells data, as JSON.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "authenticationToken": {
        "type": "apiKey",
        "in": "query",
        "name": "authentication_token",
        "description": "The token from `POST /sessions`, sent as the `authentication_token` query parameter."
      },
      "authenticationTokenHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "authentication-token",
        "description": "The same token, sent in the `authentication-token` header instead."
      }
    }
  },
  "security": [
    {
      "authenticationToken": []
    },
    {
      "authenticationTokenHeader": []
    }
  ]
}
