The Greenspark Reports SDK provides access to the Greenspark Reports API from applications running on a server or in a browser.
See the @greenspark/reports
API docs for details.
Node 16 or higher.
Install the package with:
npm install @getgreenspark/reports --save
The SDK use the production
environment by default. You only need to provide your API key.
const reportsApi = new ReportsApi({apiKey: "<YOUR_API_KEY>"})
The SDK use the production
environment by default. You can use the sandbox
environment for testing and development by providing the sandbox
environment basePath
and your API key.
const reportsApi = new ReportsApi({basePath: "https://sandbox.getgreenspark.com", apiKey: "<YOUR_API_KEY>"})
The SDK needs to be configured with your Greenspark API key, which is available in the Greenspark Dashboard.
import {RawReport, ReportsApi} from "@greenspark/reports";
const reportsApi = new ReportsApi({apiKey: "<YOUR_API_KEY>"})
const {data}: RawReport = await reportsApi.fetchRawReportV2()
console.log(data);