Emissions

List canonical emission filter facets

Changed on
get/emissions/canonical/facets

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/emissions/canonical/facets
  • Auth: HTTP bearer

Query parameters

startDatestring date-time
endDatestring date-time
querystring
scopeinteger[]
regionCodestring[]
locationIdstring[]
siteIdsstring[]

Keep rows stamped with one of these sites (site_…); the value "unassigned" keeps rows with no site (entity-only rows included). A site of another organization matches nothing, like an unknown id. At most 100 values; more answer 400.

categoryNamestring[]
supplierDisplaystring[]
amountUnitstring[]
originstring[]
provenanceStatusstring[]
minCo2eTonnesnumber
maxCo2eTonnesnumber
documentIdstring

Upload ID used to restrict canonical emissions to one document.

item_type'carbon' | 'all'
missingSpendboolean

When true, keep only the rows that need a cost input: carbon rows with no spend, excluding well-to-tank and transmission-and-distribution rows.

utilityUnmatchedboolean

When true, keep only the carbon rows the Utility page could not match to a utility (the rows behind UtilitySeries.unmatched): classified as resource "other" while their factor category or factor name looks like energy, water or waste, unless their factor was mapped to "other" by hand. With startDate=<startMonth>-01T00:00:00Z, endDate=<last day of endMonth>T23:59:59.999Z (default overlap basis) and the series' siteIds it lists exactly the rows the series counts.

usage'building' | 'vehicle' | 'unassigned' | 'other'

Keep only the rows with this utility usage classification.

dateBasis'overlap' | 'start'

How startDate and endDate select rows. overlap (default) keeps the rows whose period [start, end] overlaps the range. start keeps only the rows whose start timestamp falls within [startDate, endDate] inclusive, the basis the utility series buckets months by.

Response

Canonical emission filter facets

metaobject

Changes

    • info

      added the new optional query request parameter siteIds

    • info

      added the new optional query request parameter utilityUnmatched

    • info

      added the new optional query request parameter dateBasis

    • info

      added the new optional query request parameter missingSpend

    • info

      added the new optional query request parameter usage