---
title: "Search and list Estimation Methods with calculator configs and runs"
method: POST
path: "/app/v1/estimation_methods/search/configurations"
tags: ["estimation_methods"]
---

# Search and list Estimation Methods with calculator configs and runs

`POST /app/v1/estimation_methods/search/configurations`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'name' | 'year_month' | 'entity_id' | 'entity_type' | 'analytics_library_id' | 'analytics_calculator_id' | 'created_at' | 'updated_at'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Estimation Methods where it can filter based on any of these following fields.
    - `equipment.custom_attributes` object
    - `equipment.id` string
    - `equipment.name` string
    - `equipment.status` 'active' | 'inactive' | 'deprecated'
    - `equipment.type.id` string
    - `equipment.type.name` string
    - `flow.id` string
    - `flow.name` string
    - `flow.status` 'active' | 'inactive'
    - `flow.type` string — Use `id` value of any index in `GET /v1/flow_types`
    - `flow.product_type` string — Use `id` value of any index in `GET /v1/product_types`
    - `flow.product_category` string — Use `id` value of any index in `GET /v1/product_categories`
    - `flow.custom_attributes` CustomAttributes
    - `flow.associated_facility_id` string, uuid
    - `flow.associated_equipment_id` string, uuid
    - `equipment.facility.custom_attributes` object
    - `equipment.facility.id` string
    - `equipment.facility.name` string
    - `equipment.facility.status` string
    - `flow.facility.custom_attributes` object
    - `flow.facility.id` string
    - `flow.facility.name` string
    - `flow.facility.status` string
    - `flow.equipment.custom_attributes` object
    - `flow.equipment.id` string
    - `flow.equipment.name` string
    - `flow.equipment.status` 'active' | 'inactive' | 'deprecated'
    - `flow.equipment.type.id` string
    - `asset_group.id` string
    - `asset_group.name` string
    - `asset_group.status` 'active' | 'inactive'
    - `asset_group.asset_group_type_id` string
    - `asset_group.custom_attributes` object
    - `configuration.estimation_method_id` string, uuid
    - `configuration.year_month` string
    - `configuration.calculator_version` string
    - `configuration.created_at` string, date-time
    - `configuration.updated_at` string, date-time
    - `year_month` object, required
      - `$in` string[]
    - `id` string
    - `name` string
    - `entity_id` string
    - `entity_name` string
    - `entity_type` 'equipment' | 'flow' | 'asset_group'
    - `analytics_library_id` string
    - `analytics_calculator_id` string
    - `estimation_method_status` string
    - `facility_id` string, uuid
    - `facility_name` string
    - `status` 'not_configured' | 'missing_inputs' | 'ready_to_run' | 'run' | 'requires_re_run'
    - `reporting_group_id` string
    - `created_at` string
    - `created_by` string
    - `updated_at` string
    - `updated_by` string

## Response `200`

Successfully something

- PagedEstimationMethodWithConfigurationList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` object[]
    - `id` string, uuid, required
    - `company_id` string, uuid, required
    - `asset_id` string, uuid, required
    - `analytics_library_id` string, required
    - `analytics_calculator_id` string, required
    - `name` string, required
    - `default_values` object, required
    - `default_asset_values` object, required
    - `created_at` union, required
      - string, date-time
      - string, nullable
      - unknown
    - `updated_at` union, required
      - string, date-time
      - string, nullable
      - unknown
    - `created_by` string, uuid, required
    - `updated_by` string, uuid, required
    - `estimation_method_status` 'active' | 'inactive', required
    - `year_month` string, required
    - `entity_type` 'equipment' | 'flow' | 'asset_group', required
    - `entity_id` string, uuid, required
    - `facility_id` string, uuid
    - `facility_name` string
    - `entity_name` string
    - `entity_type_type` string — eg. equipment type or facility type
    - `status` 'not_configured' | 'missing_inputs' | 'ready_to_run' | 'run' | 'requires_re_run'
    - `calculator_configuration` EstimationMethodConfiguration
      - `estimation_method_id` string, uuid
      - `inputs` AnalyticsCalculatorInputs
      - `asset_inputs` AnalyticsCalculatorAssetInputs
      - `calculator_version` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `company_id` string, uuid
      - `input_sources` CalculatorInputSources
      - `asset_input_sources` object
    - `calculator_run` CalculatorRunResponse
      - `estimation_method_id` string, uuid
      - `year_month` string
      - `calculation_end` string, date-time
      - `calculation_start` string, date-time
      - `created_by` string, uuid
      - `company_id` string, uuid
      - `configuration_input` object
      - `configuration_asset_input` object
      - `input` CalculatorInput
        - `id` string
        - `calculation` CalculatorInputCalculation
          - `calculation_id` string
          - `calculation_parameters` object
      - `output` CalculatorOutput
        - `intermediates` CalculatorOutputMeasurement[]
          - `measurement_quantity` string
          - `measurement_type` string
          - `measurement_unit` string
          - `measurement_value` number
          - `description` string
          - `type` string
          - `calculator_run_id` string, uuid
        - `outputs` CalculatorOutputMeasurement[]
          - `measurement_quantity` string
          - `measurement_type` string
          - `measurement_unit` string
          - `measurement_value` number
          - `description` string
          - `type` string
          - `calculator_run_id` string, uuid
    - `reporting_groups` ReportingGroupInput[]
      - `name` string
      - `description` string
      - `priority` number — default to 1
      - `id` string

---

[API](https://skmtc.net/validere/apis/carbonhub-api.md) · [All operations](https://skmtc.net/validere/apis/carbonhub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/validere/carbonhub-api/revisions/053edab62415/schema)