Skip to main content
GET
/
v1
/
activity
Get high level activity data
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",
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Name",
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-31T23:59:59.000Z",
      "syncId": "sync123",
      "description": "<string>",
      "quantity": 150,
      "unit": "kg",
      "UpstreamCO2e": "1234",
      "DownstreamCO2e": "0.5678",
      "product": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Product Name"
      },
      "scope": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Scope 2: Electricity"
      },
      "taxonomy": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Material"
      },
      "org": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Org Unit"
      },
      "startDate": "2021-01-01T00:00:00.000Z",
      "endDate": "2021-01-01T00:00:00.000Z",
      "CO2e": "1234.5678"
    }
  ],
  "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 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

Query Parameters

date
string
Example:
sd
string
Example:
ed
string
Example:
org
string
Example:
scope
string
Example:
taxonomy
string
Example:
list
string[]

Response

count
integer
Example:
queryString
string
Example:
startDate
string
Example:
endDate
string
Example:
CO2e
string
Example:
uncategorizedCO2e
string
Example:
CO2eUnit
string
Example:
data
object[]
scopes
object[]
orgs
object[]
taxonomies
object[]