v3/datasets/{datasetId}/product-epds/statistics:filter
Retrieves statistics for product EPDs in the specified dataset.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/product-epds/statistics:filter |
| Authentication Context | User context required |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.
The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
| Content-Type* string | Must be application/json |
Request
URI Parameters
| datasetId string | Unique identifier for the dataset. Use this value as the datasetId URI parameter in API requests to access that dataset’s data. |
Request
Body Structure
Filter criteria to narrow down product EPDs for statistics.
| filters* object | Map of filter id to filter clause. Keys are filter identifiers; values are { op, value } objects. An empty object applies no filtering. Omit optional known filters rather than sending null as the clause value. |
| ** object | A well-formed filter clause. Each key under filters in the request body must map to an object with op and value. Sending explicit null as the clause (instead of { op, value }) is invalid. The value field may be null as a primitive when the operator allows it. |
| op* enum:string | Filter operator. Must be one of the supported operators.
Possible values: EQ, NEQ, IN, NOT_IN, LT, LTE, GT, GTE, CONTAINS, BETWEEN |
| value* one of | Filter value. For scalar operators (EQ, NEQ, LT, LTE, GT, GTE, CONTAINS), supply a single primitive (string, number, boolean, or null). For array operators (IN, NOT_IN), supply an array of primitives. For BETWEEN, supply a 2-element array representing the inclusive range bounds. |
| 0* string | |
| 1* number | |
| 2* boolean | |
| 3* array | |
| oneOf* array:oneOf | |
| 0* string | |
| 1* number | |
| 2* boolean |
Response
HTTP Status Code Summary
| 200 OK | Product EPDs statistics were successfully retrieved. |
| 400 Bad Request | The request could not be processed due to invalid or malformed data. Check the request parameters, body format, and required fields before retrying. |
| 401 Unauthorized | The supplied authorization header was invalid or the token scope was not acceptable. Verify your authentication credentials and try again. |
| 403 Forbidden | The request was valid but lacked the necessary permissions. Verify your credentials and permissions before sending the request again. |
| 404 Not Found | The requested resource could not be found on the server. Review the request and try again. |
| 422 Unprocessable Entity | The dataset does not declare the data type required by this route in supportedDataTypes. Use GET /v3/datasets to inspect supportedDataTypes for the dataset. |
| 424 | The request could not be completed because the data provider failed or does not support this operation. Inspect the response body’s type, title, and detail fields to determine the cause: NOT_FOUND means the operation is unsupported for this dataset; AUTH_ERROR means the provider could not authenticate the request due to invalid credentials or token; RESOURCE_NOT_FOUND means the requested resource could not be found; REQUEST_LIMIT_EXCEEDED means the data provider has reached its request limit. Please reach out to them; UNKNOWN means the provider encountered an unexpected error. |
Response
Body Structure (200)
| data one of | Statistical summary values for a dataset. |
| EmptyStatistics object | |
| count int | Zero count indicates no EPDs matched the applied filters. Will always be: 0 |
| FullStatistics object | |
| declaredUnit object | Declared unit for measurements |
| qty number | Quantity value for the declared unit |
| unit enum:string | Canonical unit code. Mass units: t is the metric tonne (exactly 1000 kg); ton is the US short ton (exactly 907.18474 kg). These are distinct and not convertible within SDA.
Possible values: cm, ft, ft2, in, item, kg, kW, kWh, m, m2, m3, MJ, mm, MPa, psi, t, ton, tkm, W, year, yd3 |
| indicator string | The impact indicator type |
| methodology string | The assessment methodology used |
| a1a2a3 object | A scientific value with units and uncertainty for reporting statistical data of impacts. This version excludes percentile distributions for simplified responses. |
| mean object | A unit-value pair representing a measurement with its associated unit. A qty can be a negative number.
Common units include:
|
| unit enum:string | The unit of the amount. All supported units:
Physical measurements:
Mass:
Energy & Power:
Environmental Impact:
Toxicity:
Other specialized units:
Possible values: |
| qty number | Quantity of unit |
| min object | A unit-value pair representing a measurement with its associated unit. A qty can be a negative number.
Common units include:
|
| unit enum:string | The unit of the amount. All supported units:
Physical measurements:
Mass:
Energy & Power:
Environmental Impact:
Toxicity:
Other specialized units:
Possible values: |
| qty number | Quantity of unit |
| max object | A unit-value pair representing a measurement with its associated unit. A qty can be a negative number.
Common units include:
|
| unit enum:string | The unit of the amount. All supported units:
Physical measurements:
Mass:
Energy & Power:
Environmental Impact:
Toxicity:
Other specialized units:
Possible values: |
| qty number | Quantity of unit |
| sd number | Standard deviation of measurement for these search results |
| count int | Number of EPDs (e.g. product or industry EPDs, depending on the endpoint) included in the statistical aggregate after applying request filters. |
| appliedFilters object | Present on every successful :filter response; may be an empty object. Maps filter ids the client sent that were used for this action to { requested, applied, warnings? } entries. |
| * object | An applied filter entry showing the requested and applied filter values. |
| requested object | The filter value as requested by the client. |
| op enum:string | The filter operator.
Possible values: EQ, NEQ, IN, NOT_IN, LT, LTE, GT, GTE, CONTAINS, BETWEEN |
| value one of | The filter value. Can be a single string, number, boolean, an array of strings, an array of numbers, or null. |
| 0 string | |
| 1 number | |
| 2 boolean | |
| 3 array: string | |
| 4 array: number | |
| applied object | The filter value as actually applied. |
| op enum:string | The filter operator.
Possible values: EQ, NEQ, IN, NOT_IN, LT, LTE, GT, GTE, CONTAINS, BETWEEN |
| value one of | The filter value. Can be a single string, number, boolean, an array of strings, an array of numbers, or null. |
| 0 string | |
| 1 number | |
| 2 boolean | |
| 3 array: string | |
| 4 array: number | |
| warnings array: string | Optional warnings about the applied filter. |
| ignoredFilters object | Present on every successful :filter response; may be an empty object. Maps filter ids the client sent that are not supported for this action (per filter discovery for that resource and action) to { reason } entries. Keys must match the client’s filter ids exactly. Every filter entry in the request must be a valid { op, value } clause (see the filter request schema) or the request fails with 400. |
| * object | An ignored filter entry with the reason it was ignored. |
| reason string | The reason the filter was ignored. For filter ids not supported on this action, the response uses the fixed string Filter is not supported by this connector. |
Example
Product EPDs statistics were successfully retrieved.
Request
curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/product-epds/statistics:filter' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"filters": {
"jurisdictions": {
"op": "IN",
"value": [
"US",
"CA"
]
}
}
}'
Response
{
"data": {
"count": 0
},
"appliedFilters": {
"categoryId": {
"requested": {
"op": "EQ",
"value": "cat-masterformat-033000"
},
"applied": {
"op": "EQ",
"value": "cat-masterformat-033000"
}
},
"jurisdictions": {
"requested": {
"op": "IN",
"value": [
"US",
"CA"
]
},
"applied": {
"op": "IN",
"value": [
"US"
]
},
"warnings": [
"Value 'CA' is not supported for jurisdictions and was ignored."
]
}
},
"ignoredFilters": {
"unknown_filter": {
"reason": "Filter is not supported by this connector."
}
}
}