Get analytics for shipping estimates
HTTPGET to /v1/analytics/shipping/public/{account_id}Query parameters
account_idstringrequired
The account identifier the analytics belongs to.
fromstring (date)
The start date of the custom date range. Defaults to 30 days ago if not specified.
throughstring (date)
The to (inclusive) date of the custom date range. Defaults to the current date if not specified.
intervalstring
The time interval over which metrics should be aggregated. Defaults to day if not specified.
daymonthResponse
emission_timeseriesarrayrequired
Timeseries containing the total emissions (tCO₂e) for the various shipping methods. Each element refers to a particular timeframe as seen on date.
object
datestring (date)required
airnumberrequired
seanumberrequired
roadnumberrequired
railnumberrequired
inland_waterwaynumberrequired
logistic_sitenumberrequired
carbon_intensity_timeseriesarrayrequired
Timeseries containing the mean value of the carbon intensities (gCO₂e/tkm) for shipping estimates. The value represents the emission per tonnes transported per kilometer traveled.
object
datestring (date)required
averagenumberrequired
carbon_intensity_totalnumberrequired
Total carbon intensity for the returned timeframe.
accountobjectrequired
Information about the account the analytics are associated with.
namestringrequired
The account's name.
typestringrequired
The account's type.
livetestlogostringrequirednullable
The account's logo URL.
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet cumulative analytics
HTTPGET to /v1/analytics/cumulative-per-bundleQuery parameters
fromstring (date)
The start date of the custom date range. Defaults to 30 days ago if not specified.
throughstring (date)
The to (inclusive) date of the custom date range. Defaults to the current date if not specified.
Response
array
An array of analytics by bundle objects.
object
An array of analytics by bundle objects.
bundle_idstringrequired
The bundle's unique identifier
bundle_namestringrequired
The bundle's name
timeseriesarrayrequired
A timeseries of quantities and values.
object
datestring (date)required
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
quantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2)
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet emission calculation metrics
HTTPGET to /v1/analytics/emission-calculationsQuery parameters
fromstring (date)
The start date of the custom date range. Defaults to 30 days ago if not specified.
throughstring (date)
The to (inclusive) date of the custom date range. Defaults to the current date if not specified.
intervalstring
The time interval over which metrics should be aggregated. Defaults to day if not specified.
daymonthall_accountsstring
When true, metrics will include data from all accounts in the organisation. When false, metrics will only include data from the API Key's default account. Defaults to false.
Response
timeseriesarrayrequired
A timeseries representing counters.
object
datestring (date)required
countnumberrequired
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet metrics
HTTPGET to /v1/analytics/metricsQuery parameters
fromstring (date)
The start date of the custom date range. Defaults to 30 days ago if not specified.
throughstring (date)
The to (inclusive) date of the custom date range. Defaults to the current date if not specified.
Response
number_of_un_sdgsnumberrequired
The number of supported UN Sustainable Development Goals (SDGs).
number_of_projectsnumberrequired
The number of supported carbon offset projects.
un_sdgarrayrequirednullable
The list of supported UN Sustainable Development Goals (SDGs).
The array is sorted by the goal number (the un_sdg_number field), ascending.
object
un_sdg_numbernumberrequired
The number which identifies the specific UN SDG.
occurrencesnumberrequired
The total number of projects supporting this UN SDG.
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_foundGet aggregated analytics by property
HTTPGET to /v1/analytics/aggregated-by-propertyQuery parameters
fromstring (date)
The start date of the custom date range. Defaults to 30 days ago if not specified.
throughstring (date)
The to (inclusive) date of the custom date range. Defaults to the current date if not specified.
Response
bundlearrayrequired
An array of objects describing a bundle's aggregated orders.
object
bundle_idstringrequired
The bundle's unique identifier.
bundle_namestringrequired
The bundle's name.
quantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2).
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
CO2 offsets' monetary value.
locationarrayrequired
An array of objects describing a location's aggregated orders.
object
locationstringrequired
Project location (continent). If a project has yet to be assigned 'Not yet allocated' is returned instead.
quantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2).
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
CO2 offsets' monetary value
registryarrayrequired
An array of objects describing a registry's aggregated orders.
object
registry_nameoneOfrequiredActual registry
Actual registry
The project's Verification Standard Entity name or equivalent organization. If a project has no registry, 'Not certified' is returned. If a project has yet to be assigned, 'Not yet allocated' is returned.
quantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2).
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
CO2 offsets' monetary value.
oxford_offsetting_principlesarrayrequired
An array of objects describing aggregated orders for each Oxford Offsetting Principle's type.
object
typenumberrequired
Oxford Offsetting Principles' type.
https://lune.co/blog/the-oxford-offsetting-principles-a-framework-to-maximise-the-impact-of-business-carbon-offsetting/.
quantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2)
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
CO2 offsets' monetary value
offset_typearrayrequired
An array of objects describing aggregated orders by offset type.
object
offset_typestringrequirednullable
Offset type classification
emissions_reductioncarbon_removalquantitystringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
Quantity of CO2 offsets linked to this activity (tonnes CO2)
valuestringrequired
Pattern: ^[0-9]+(\.[0-9]+)?$
CO2 offsets' monetary value
Errors
This API operation can return the following errors:400api_version_invalid400bundle_selection_ratios_invalid400bundle_selection_bundle_invalid400order_value_invalid400bundle_id_invalid400id_invalid400distance_invalid400test_account_name_update_disallowed400bundle_selection_ratios_invalid_format400address_not_found