{
  "opencollection": "1.0.0",
  "info": {
    "name": "Greenspark Climate Account Reports API",
    "version": "2.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Fetch a Report Page",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/:reportId/:cursor",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The id of a previously generated report."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "path",
                "description": "The cursor identifies the next page within a report."
              }
            ]
          },
          "docs": "Deprecated — returns 404 at runtime. Use v2 fetchRawReportV2 (GET /v2/reports) with cursor pagination."
        },
        {
          "info": {
            "name": "Fetch Average Spend Per Impact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/average-spend-per-impact",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of average spending on impacts per currency."
        },
        {
          "info": {
            "name": "Fetch Carbon By Interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/carbon-by-interval",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts of carbon per month."
        },
        {
          "info": {
            "name": "Fetch Impact Amount By Type Per Source Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/impact-amount-by-type-per-source",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts on a single type and source."
        },
        {
          "info": {
            "name": "Fetch Impact Amount By Type Per Trigger Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/impact-amount-by-type-per-trigger",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts on a single type and trigger."
        },
        {
          "info": {
            "name": "Fetch Impacts By Interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/impacts-by-interval",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts per month."
        },
        {
          "info": {
            "name": "Fetch Plastic By Interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/plastic-by-interval",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts of plastic per month."
        },
        {
          "info": {
            "name": "Fetch Raw Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              },
              {
                "name": "impactType",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ]
          },
          "docs": "Deprecated — returns 404 at runtime. Use v2 fetchRawReportV2 (GET /v2/reports)."
        },
        {
          "info": {
            "name": "Fetch Raw Report v2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v2/reports",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              },
              {
                "name": "impactType",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The cursor identifies the next page within a report."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Fetch Total Impact By Sources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/total-impact-by-sources",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of impacts amount per source."
        },
        {
          "info": {
            "name": "Fetch Total Impact By Triggers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/total-impact-by-triggers",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of impacts amount per trigger."
        },
        {
          "info": {
            "name": "Fetch Total Impact By Type Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/total-impact-by-type",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts on a single type."
        },
        {
          "info": {
            "name": "Fetch Total Impacts Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/total-impacts-count",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the total number of impacts."
        },
        {
          "info": {
            "name": "Fetch Total Spend On Impacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/total-spend-on-impacts",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of total spending on impacts per currency."
        },
        {
          "info": {
            "name": "Fetch Trees By Interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getgreenspark.com/v1/reports/trees-by-interval",
            "params": [
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "The id of the source associated with the impact."
              },
              {
                "name": "triggerId",
                "value": "",
                "type": "query",
                "description": "The id of the trigger associated with the impact."
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "The beginning of the date filter interval."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The end of the date filter interval."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "You can filter the data by the provided key-value pairs as Metadata."
              },
              {
                "name": "sourceType",
                "value": "",
                "type": "query",
                "description": "The source type of the impact, one of \"one-time\", \"subscription\"."
              }
            ]
          },
          "docs": "Fetch the Array of spending on impacts of trees per month."
        }
      ]
    }
  ],
  "bundled": true
}