API Reference

Fetch Raw Report v2

get
https://api.getgreenspark.com/v2/reports

Canonical raw impact export. Paginate with the cursor query parameter when the response includes a non-null cursor. Row metadata may contain merchant-defined key/value pairs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The id of the source associated with the impact.

string

The id of the trigger associated with the impact.

string

The beginning of the date filter interval.

string

The end of the date filter interval.

string

You can filter the data by the provided key-value pairs as Metadata.

string
enum

The source type of the impact, one of "one-time", "subscription".

Allowed:
string
enum

Type can be trees, plastic or carbon. As a result only the impacts containing the provided impact type will be returned. If they contain other impact types as well, those won't be filtered out.

Allowed:
string

The cursor identifies the next page within a report.

Responses

400

Bad request.

401

Provide a valid x-api-key header. Keys are created in the Greenspark dashboard after registration (separate key per environment).

403

Requires premiumBusiness, premiumBusinessYearly, or enterpriseBusiness subscription.

404

Not found.

422

422 Unprocessable Entity when API quota is exhausted (MAX_API_CALLS_REACHED).

Updated 1 day ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago