PACT Footprint

Get a Product Carbon Footprint

curl --request GET \
  --url https://app.variable.global/api/pact/2/footprint/:id \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "specVersion": "2.1.0",
    "precedingPfIds": "<array>",
    "version": 1,
    "status": "Active",
    "statusComment": "<string>",
    "validityPeriodStart": "2023-11-07T05:31:56Z",
    "validityPeriodEnd": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "companyIds": "<array>",
    "productIds": "<array>",
    "productCategoryCpc": "<string>",
    "productNameCompany": "<string>",
    "productDescription": "<string>",
    "comment": "<string>",
    "pcf": {
      "declaredUnit": "kilogram",
      "unitaryProductAmount": 1234.5678,
      "pCfExcludingBiogenic": 1234.5678,
      "pCfIncludingBiogenic": 1234.5678,
      "fossilGhgEmissions": 1234.5678,
      "fossilCarbonContent": 1234.5678,
      "biogenicCarbonContent": 1234.5678,
      "dLucGhgEmissions": 1234.5678,
      "landManagementGhgEmissions": 1234.5678,
      "otherBiogenicGhgEmissions": 1234.5678,
      "iLucGhgEmissions": 1234.5678,
      "biogenicCarbonWithdrawal": 1234.5678,
      "aircraftGhgEmissions": 1234.5678,
      "characterizationFactors": "AR6",
      "ipccCharacterizationFactorsSources": [
        "AR6"
      ],
      "crossSectoralStandardsUsed": [
        "GHG Protocol Product standard"
      ],
      "productOrSectorSpecificRules": "<array>",
      "biogenicAccountingMethodology": "GHGP",
      "boundaryProcessesDescription": "<string>",
      "referencePeriodStart": "2023-11-07T05:31:56Z",
      "referencePeriodEnd": "2023-11-07T05:31:56Z",
      "geographyCountrySubdivision": "US-PA",
      "geographyCountry": "NO",
      "geographyRegionOrSubregion": "Europe",
      "secondaryEmissionFactorSources": "<array>",
      "exemptedEmissionsPercent": 2,
      "exemptedEmissionsDescription": "<string>",
      "packagingEmissionsIncluded": true,
      "packagingGhgEmissions": 1234.5678,
      "allocationRulesDescription": "<string>",
      "uncertaintyAssessmentDescription": "<string>",
      "primaryDataShare": 82,
      "dqi": {
        "coveragePercent": 80,
        "technologicalDQR": 2,
        "temporalDQR": 2,
        "geographicalDQR": 2,
        "completenessDQR": 2,
        "reliabilityDQR": 2
      }
    },
    "extensions": "<array>",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
}

GET

pact

footprint

:id

Get a Product Carbon Footprint

curl --request GET \
  --url https://app.variable.global/api/pact/2/footprint/:id \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "specVersion": "2.1.0",
    "precedingPfIds": "<array>",
    "version": 1,
    "status": "Active",
    "statusComment": "<string>",
    "validityPeriodStart": "2023-11-07T05:31:56Z",
    "validityPeriodEnd": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "companyIds": "<array>",
    "productIds": "<array>",
    "productCategoryCpc": "<string>",
    "productNameCompany": "<string>",
    "productDescription": "<string>",
    "comment": "<string>",
    "pcf": {
      "declaredUnit": "kilogram",
      "unitaryProductAmount": 1234.5678,
      "pCfExcludingBiogenic": 1234.5678,
      "pCfIncludingBiogenic": 1234.5678,
      "fossilGhgEmissions": 1234.5678,
      "fossilCarbonContent": 1234.5678,
      "biogenicCarbonContent": 1234.5678,
      "dLucGhgEmissions": 1234.5678,
      "landManagementGhgEmissions": 1234.5678,
      "otherBiogenicGhgEmissions": 1234.5678,
      "iLucGhgEmissions": 1234.5678,
      "biogenicCarbonWithdrawal": 1234.5678,
      "aircraftGhgEmissions": 1234.5678,
      "characterizationFactors": "AR6",
      "ipccCharacterizationFactorsSources": [
        "AR6"
      ],
      "crossSectoralStandardsUsed": [
        "GHG Protocol Product standard"
      ],
      "productOrSectorSpecificRules": "<array>",
      "biogenicAccountingMethodology": "GHGP",
      "boundaryProcessesDescription": "<string>",
      "referencePeriodStart": "2023-11-07T05:31:56Z",
      "referencePeriodEnd": "2023-11-07T05:31:56Z",
      "geographyCountrySubdivision": "US-PA",
      "geographyCountry": "NO",
      "geographyRegionOrSubregion": "Europe",
      "secondaryEmissionFactorSources": "<array>",
      "exemptedEmissionsPercent": 2,
      "exemptedEmissionsDescription": "<string>",
      "packagingEmissionsIncluded": true,
      "packagingGhgEmissions": 1234.5678,
      "allocationRulesDescription": "<string>",
      "uncertaintyAssessmentDescription": "<string>",
      "primaryDataShare": 82,
      "dqi": {
        "coveragePercent": 80,
        "technologicalDQR": 2,
        "temporalDQR": 2,
        "geographicalDQR": 2,
        "completenessDQR": 2,
        "reliabilityDQR": 2
      }
    },
    "extensions": "<array>",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
}

The path is relative to your company specific url:https://your_subdomain.variable.global/api

Only footprints that are valid according to the PACT standard will show in the API, regardless of the sharing setting.This generally means footprints that have all of the required fields filled out. Details on the PACT standard and required fields can be found in the PACT documentation.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

A Product Carbon Footprint

data

object

Show child attributes

data.id

string

Example:

123

data.specVersion

string

Example:

"2.1.0"

data.precedingPfIds

array

data.version

string

Example:

1

data.status

string

Example:

"Active"

data.statusComment

string

data.validityPeriodStart

string<date-time>

data.validityPeriodEnd

string<date-time>

data.companyName

string

data.companyIds

array

data.productIds

array

data.productCategoryCpc

string

data.productNameCompany

string

data.productDescription

string

data.comment

string

data.pcf

object

Show child attributes

data.pcf.declaredUnit

string

Example:

"kilogram"

data.pcf.unitaryProductAmount

string

Example:

1234.5678

data.pcf.pCfExcludingBiogenic

string

Example:

1234.5678

data.pcf.pCfIncludingBiogenic

string

Example:

1234.5678

data.pcf.fossilGhgEmissions

string

Example:

1234.5678

data.pcf.fossilCarbonContent

string

Example:

1234.5678

data.pcf.biogenicCarbonContent

string

Example:

1234.5678

data.pcf.dLucGhgEmissions

string

Example:

1234.5678

data.pcf.landManagementGhgEmissions

string

Example:

1234.5678

data.pcf.otherBiogenicGhgEmissions

string

Example:

1234.5678

data.pcf.iLucGhgEmissions

string

Example:

1234.5678

data.pcf.biogenicCarbonWithdrawal

string

Example:

1234.5678

data.pcf.aircraftGhgEmissions

string

Example:

1234.5678

data.pcf.characterizationFactors

string

Example:

"AR6"

data.pcf.ipccCharacterizationFactorsSources

array

Example:

["AR6"]

data.pcf.crossSectoralStandardsUsed

array

Example:

["GHG Protocol Product standard"]

data.pcf.productOrSectorSpecificRules

array

data.pcf.biogenicAccountingMethodology

string

Example:

"GHGP"

data.pcf.boundaryProcessesDescription

string

data.pcf.referencePeriodStart

string<date-time>

data.pcf.referencePeriodEnd

string<date-time>

data.pcf.geographyCountrySubdivision

string

Example:

"US-PA"

data.pcf.geographyCountry

string

Example:

"NO"

data.pcf.geographyRegionOrSubregion

string

Example:

"Europe"

data.pcf.secondaryEmissionFactorSources

array

data.pcf.exemptedEmissionsPercent

number

Example:

2

data.pcf.exemptedEmissionsDescription

string

data.pcf.packagingEmissionsIncluded

boolean

data.pcf.packagingGhgEmissions

string

Example:

1234.5678

data.pcf.allocationRulesDescription

string

data.pcf.uncertaintyAssessmentDescription

string

Example:

82

data.pcf.dqi

object

Show child attributes

data.pcf.dqi.coveragePercent

number

Example:

80

data.pcf.dqi.technologicalDQR

number

number from 1 - 3

Example:

2

data.pcf.dqi.temporalDQR

number

number from 1 - 3

Example:

2

data.pcf.dqi.geographicalDQR

number

number from 1 - 3

Example:

2

data.pcf.dqi.completenessDQR

number

number from 1 - 3

Example:

2

data.pcf.dqi.reliabilityDQR

number

number from 1 - 3

Example:

2

data.extensions

array

data.created

string<date-time>

data.updated

string<date-time>

PACT Footprints

⌘I

Getting Started

Endpoints

Authorizations

Response