Skip to main content
POST
/
dct
DCT - Get Module CSV Data
curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/modulecsv/dct \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "oarIds": [
    "<string>"
  ],
  "assessmentIds": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "accountSacIds": [
    "<string>"
  ],
  "version": "fem2017",
  "status": [
    "NS"
  ],
  "verified": true,
  "include": [
    "<string>"
  ],
  "lastUpdated": 123,
  "lastActivityDate": 123,
  "lastStatusChange": 123,
  "lastASCStatusDate": 123,
  "greaterThanYear": 123,
  "cafVersion": "1.7",
  "dctVersion": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": {}
    }
  ],
  "nextPage": "<string>",
  "facilityPosted": true,
  "sipfacilitytype": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>",
      "value": "asc"
    }
  ],
  "verificationPosted": 123,
  "rfi_pid": "fem2017",
  "wildcardSearch": {
    "sacId": "<string>",
    "accountName": "<string>",
    "oarId": "<string>",
    "tags": "<string>",
    "accountId": "<string>",
    "customId": "<string>",
    "ffcId": "<string>"
  },
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "isBaseMaterialFilter": true
}
'

​
Overview

This endpoint can be used to retrieve any of the monthly data submissions from facilities that are shared with you on Worldly. For additional details about what kinds of data are included, see more at the data dictionary. This endpoint is paginated for performance purposes and returns each submission in JSON. This endpoint supports a variety of query and include options, outlined below.

​
Specify what data fields to return (include)

Specify an array of which groups of indicators to retrieve for an assessment.
  • questions will return ALL questions. Can be narrowed to questions by section.
  • calculations will return all quantitative calculations. Can be narrowed to calculation by section.
  • performancewill include the best available submission data (validated or self-submitted), common unit conversions (e.g., MJ, L), and GHG emissions for the key sources and totals.
  • allocationswill include the production allocation and MJ impact for your specific brand for each FDM submission . Allocation data is proprietary information - your allocated portion will never be seen by another brand.
Note that this can also be limited down to individual indicators.
Example Include Statement
"include": [
        "questions.site",
        "calculations.ghg.ensourceelectricpurchtotalghg"
    ],

​
Specify which records to return (query)

Timestamps in unix time for the reporting month and reporting year.For example, to retrieve assessments for the period Jan - Mar 2024:"reportingPeriodStart": 1704096000, "reportingPeriodEnd": 1711954800,
Like FSLM, this does not have a fixed cadence so the version is always dct
Assessments from the pilot period in 2023 were version 1.0. The current version is 2.0.
An array of assessment statuses to query for.
Boolean filter for verified (true) or unverified (false) assessments
Specify an array of account identifiers to retrieve assessments for. The following Worldly account identifiers are supported as being queryable: sacId (0-6 digit number auto-assigned to every Worldly account), accountId (longer UUID auto-assigned to every Worldly account), oarId (15-character unique identifier assigned to each facility in the Open Supply Hub), ffcId (a unique identifier assigned to every user on the Fair Factories Clearinghouse platform; numeric and no longer than 9 digits) taxId (a government issued tax identifier), socialCreditId (a state-issued identifier in China), customId (a custom identifier that can be assigned to another Worldly account, only visible to the author).For example:
"accountIds": ["accountId","sacID","oarID","ffcId","taxId","socialCreditId","customId"]
Specify an array of specific assessments to retrieve data from. If not specified, retrieves all assessments of specified rfi_pid (subject to other query specifiers). Note that this can have unintuitive side-effects if you specify assessment ID’s that do not come from the specified Account ID’s.
Filter for records that have been updated since the provided timestamp. Timestamp must be in unix time in milliseconds.
Filter for records that have changed status since the provided timestamp. Timestamp must be in unix time in milliseconds
Integer value of where to start the window of results. If not specified, defaults to 0.
Integer value of how many results to return. If not specified, defaults to 10.
Note: Maximum number of results returned is 30.

​
Sort the responses

Sort the returned data by the date on which the assessment was created. Supports ASC and DESC.Example: "sort": [{ "field": "created_on", "value": "desc" }],

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json
​
from
number<double> | null
​
size
number<double> | null
​
oarIds
string[] | null
​
assessmentIds
string[] | null
​
accountIds
string[] | null
​
accountSacIds
string[] | null
​
version
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:
fem2017,
fem2018,
fem2019,
fem2020,
fem2021,
fem2022,
fem2023,
fem2024,
fem2025,
fslm,
brm2019,
brm2020,
brm2021,
brm2022,
brm2023,
brm2024,
brm2025,
dct,
one2022,
ffc
​
status
enum<string>[] | null

This interface was referenced by Exports's JSON-Schema via the definition "assessmentStatus".

Available options:
NS,
ASI,
ASC,
VRP,
VRQ,
VRE,
VRC,
VRD,
VRF,
VRI,
ASD
​
verified
boolean | null
​
include
string[] | null
​
lastUpdated
number<double> | null
​
lastActivityDate
number<double> | null
​
lastStatusChange
number<double> | null
​
lastASCStatusDate
number<double> | null
​
greaterThanYear
number<double> | null
​
cafVersion
enum<string>
Available options:
1.7,
1.6,
1.5,
1.4,
1.3
​
dctVersion
string | null
​
filters
object[] | null
​
nextPage
string | null
​
facilityPosted
boolean | null
​
sipfacilitytype
string[] | null
​
sort
object[] | null
​
verificationPosted
number<double> | null
​
rfi_pid
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:
fem2017,
fem2018,
fem2019,
fem2020,
fem2021,
fem2022,
fem2023,
fem2024,
fem2025,
fslm,
brm2019,
brm2020,
brm2021,
brm2022,
brm2023,
brm2024,
brm2025,
dct,
one2022,
ffc
​
wildcardSearch
object
​
reportingPeriodStart
number<double> | null
​
reportingPeriodEnd
number<double> | null
​
isBaseMaterialFilter
boolean | null

Response

204

No content