Skip to main content
GET
Get high level activity data
Requires permission activity:report to get high level data.
Requires permission activity:read to get detailed data.
Read more about the Activity data models.

Authorizations

Authorization
string
header
required

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

Query Parameters

date
string

Date to query (e.g. 2021-01-01, 2021-12, 2021)

Example:

"2021-01"

sd
string

Start date

Example:

"2021-01-01"

ed
string

End date

Example:

"2021-01-31"

org
string

The org UUID

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

scope
string

The scope UUID

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

taxonomy
string

The taxonomy UUID

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

activityGroup
string

The activity group UUID, or null for activities in no group

Example:

"aa17223a-471c-4eb7-9ff5-7800fd023960"

list
string[]

List of Scopes, Orgs, Taxonomies or activity groups used in the result set, each with the CO2e and count of its activities

return
string

Comma-separated activity fields to include in each record, named as they appear in the response (e.g. CO2e, description, supplier). Unknown fields are ignored, and a list naming no known field returns the full record.

Example:

"uuid,description,quantity,unit,CO2e"

orderBy
string

Field to sort activities by: CO2e, description, startDate (default), endDate, quantity, org, scope or supplier. Any other value is rejected with a 400.

Example:

"CO2e"

orderDir
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

A list of activities

count
integer
Example:

1500

queryString
string

The query string used to filter the activities

Example:

"date=2021-01"

startDate
string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

endDate
string

ISO 8601 date

Example:

"2021-01-31T23:59:59.000Z"

CO2e
string

The total CO2e of all activities categorized to a GHG Scope, in CO2eUnit

Example:

"1234.5678"

uncategorizedCO2e
string

The total CO2e of all activities not categorized to a GHG Scope, in CO2eUnit

Example:

"1.2345678"

CO2eUnit
string

The unit of CO2e. For example "kg"

Example:

"kg"

data
object[]
scopes
object[]

A list of GHG Scopes used in the result set. The entries add up to CO2e

orgs
object[]

A list of Orgs used in the result set. An entry leaves out its child orgs' activities, which the org filter includes

taxonomies
object[]

A list of Taxonomies used in the result set. An entry leaves out its child categories' activities, which the taxonomy filter includes

groups
object[]

A list of activity groups used in the result set