Documentation: yearly_reports

This tables aggregates the data from the reports table into yearly summaries. It allows for simplification of queries on Grafana.

To import data in this format you can use our API. -> API Documentation
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.

You can also supply us with files in xlsx, csv or json format. -> Example CSV

	Required	Type	p14n	Blurred	Autogenerated	Example
year The year for which the aggregate data is calculated. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	✓	integer	⤫	⤫	⤫	2023
category Category of the metric, indicating whether it pertains to connections or non-connections data.	✓	enum: connections, non-connections	⤫	⤫	⤫	connections
country Two-letter country code as per ISO 3166-1 alpha-2 standard representing the country of the metric.	✓	string	⤫	⤫	⤫	RW
breakdown JSON object providing the breakdown of the metric. Includes details such as connection type, end-user type, etc.	✓	jsonb	⤫	⤫	⤫	{"type": "Grid", "end_user_type": "residential", "primary_responsible_person_gender": "M"}
unit_of_measurement Unit of measurement for the metrics reported, such as kWh, number of connections, people etc.	✓	string	⤫	⤫	⤫	number
value The aggregate value of the metric being reported, such as the total number of connections, total energy consumed, or any other relevant metric aggregated for the year. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.	✓	float	⤫	⤫	⤫	1000.0
program This helps us extend the use cases for this table by linking it to the program under which the aggregated report was submitted, helping to categorize the data and link it to specific programs.	✓	string	⤫	⤫	⤫	ASCENT
uid unique identifier for each yearly aggregate entry. Derived by concatenating the following fields: [organization_id and external_id].	⤫	string	⤫	⤫	✓	123_12_c782c9d4731f26d3d040d6a4a24ebd66
external_id external identifier for each yearly aggregate entry. Derived by concatenating and hashing the following fields: [year, category, country, breakdown, reporting_phase,program, unit_of_measurement]	⤫	string	⤫	⤫	✓	c782c9d4731f26d3d040d6a4a24ebd66
reporting_phase The specific project for which the aggregate is calculated for. It helps us identify the ASCENT phase or project that the aggregate reported data belongs to.	⤫	string	⤫	⤫	⤫	P0001
created_at Timestamp when row was inserted	⤫	datetime	⤫	⤫	✓	2021-05-03 6:23:55
updated_at Timestamp when row was updated	⤫	datetime	⤫	⤫	✓	2021-05-03 6:23:55
source_id References Source of data	⤫	integer	⤫	⤫	✓	1
import_id References Import of data	⤫	integer	⤫	⤫	✓	1
organization_id References Organization of data	⤫	integer	⤫	⤫	✓	1
custom Saves additional imported data out of standard structure	⤫	jsonb	⤫	⤫	✓	{ "some": "key" }
data_origin Origin of the data, generic or name of the api	⤫	string	⤫	⤫	✓	generic
last_import_id Id of the last import which updated the record	⤫	integer	⤫	⤫	✓	337
last_source_id Id of the last Source which updated the record	⤫	integer	⤫	⤫	✓	33