Good-Loop API Documentation

Good-Data API - v0.1 alpha! This version of the API is ready for use, but parameters may change without warning.

Change Log

[0.1.2]

• Two new parameters for the /report/new endpoint:
  1. breakdown - Optional. Specify a breakdown for the report by format, domain, country
  2. q - Optional. Query string for filtering reports. Use adid:X where X is the id of a Green Tag you generated.

Authorization

An API Key is required inside of the request header for every API request.

--header 'Authorization: token <your-api-key>'

Endpoints

The Good-Loop API provides two categories of endpoints:

Carbon Measurements of Your Own Data

• POST /score
• POST /csv
• POST /csvpromise
• GET /csvpromise/{id}

Reporting of Green Ads Tag Data

• POST /report
• GET /report/{id}

Method	Endpoint	Type	You Provide	Returns	GAT Data?
POST	POST /score	Measure	Report from DSP (json string)	Measured data	No
POST	POST /csv	Measure	Report from DSP (csv file)	Measured data	No
POST	POST /csvpromise	Measure	Report from DSP (csv file)	Measurement ID (Not data)	No
GET	GET /csvpromise/{id}	Measure	Measurement ID	Measured data	No
POST	POST /report	Report	Dimension and breakdown (What data to report)	Report ID (Not data)	Yes
GET	GET /report/{id}	Report	Report ID	Report data	Yes