Sign in
estimation_methods

Export estimation methods based on search input

post/app/v1/estimation_methods/export

Request body

sort_by'name' | 'entity_id' | 'entity_type' | 'analytics_library_id' | 'analytics_calculator_id' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "entity_type": "equipment"
      },
      {
        "name": {
          "$like": "Emissions"
        }
      }
    ]
  }
}

Response

A successful with the link to download report

idstring uuid required
namestring required
company_idstring uuid required
status'exporting' | 'failed' | 'success' required
templated_report_namestring
inputobject

User input for a templated report based on the input schema for the desired templated report.

s3_object_idstring
report_versionstring
created_bystring uuid required
updated_bystring uuid required
s3_download_linkstring

Example response

{
  "input": {
    "year_month": 202201,
    "reporting_group_id": "bc37cb31-08ce-4b22-8f4c-7d44692a4ef2",
    "asset_id": "89c100dc-0401-447f-a9f5-72ae124f3244"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.