GET
/
v1
/
activity
curl --request GET \
  --url https://app.variable.global/api/v1/activity \
  --header 'Authorization: Bearer <token>'
{
  "count": 1500,
  "queryString": "date=2021-01",
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-31T23:59:59.000Z",
  "CO2e": "1234.5678",
  "uncategorizedCO2e": "1.2345678",
  "CO2eUnit": "kg",
  "scopes": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Scope 2: Electricity"
    }
  ],
  "orgs": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Org Unit"
    }
  ],
  "taxonomies": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Electricity",
      "slug": "electricity",
      "path": "energy/electricity"
    }
  ]
}
Requires permission:

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"

​
list
string[]

List of Scope, Org, or Taxonomies used in the result set

Response

200
application/json
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"

​
scopes
object[]

A list of GHG Scopes used in the result set

​
orgs
object[]

A list of Orgs used in the result set

​
taxonomies
object[]

A list of Taxonomies used in the result set