With the Reporting endpoints you can fetch detailed reports about the Impacts you have created.
RawReport Object
This represents a report with raw data about your Impacts.
Property | Type | Description |
---|---|---|
row | RawReportRow[] | One item in the array represents an Impact. |
totalRows | number | Number of rows in the report. |
maxResults | number | Maximum number of rows per page. |
cursor | string | Present if the results are spread across multiple pages. Use the cursor to fetch the next reports page. If null, it indicates that there is no further pagination. |
reportId | string | The id of your generated report. If the result are spread across multiple pages, you can refer to your report while paginating. |
RawReportRow Object
This represents an Impact in the report.
createdAt | string | Creation date of the impact. |
totalPrice | number | Total amount of money spent on the impact. |
currency | string | The currency of the spent money on the impact. |
sourceName | string | The name of the source associated with the impact. |
sourceId | string | The id of the source associated with the impact. |
triggerName | string | The name of the trigger associated with the impact. |
triggerId | string | The id of the trigger associated with the impact. |
impactPurchases | ImpactPurchase[] | The impactPurchases array contains your spending on various impacts such as trees, plastic or CO2. |
metadata | Metadata[] | In the metadata array you can store up to 50 key-value pairs. You can use them to associate data from within your application with your impact. |
ImpactPurchase Object
The impactPurchase object contains your spending on a specific impact such as trees, plastic or CO2.
Property | Type | Description |
---|---|---|
type | string | Type can be trees, plastic or carbon. |
amount | number | Amount means the number of trees, plastic bottles or kg of CO2. |
Metadata Object
WIth the Metadata object, you can differentiate your Impacts later.
Property | Type | Description |
---|---|---|
key | string | Minimum 1, maximum 40 characters. |
value | string | Minimum 1, maximum 500 characters. |