Documentation: reports

This table saves data from Ascent reports submitted by PIUs for both connections and non-connections based metrics. It saves them in the same level of granularity as the submitted report, allowing for validation checks and data ingestion.

Pour importer des données dans ce format, vous pouvez utiliser notre API. -> Documentation de l'API
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.

Vous pouvez également nous fournir des fichiers au format xlsx, csv ou json. -> Exemple CSV

Nom de la ligne	Type	Exemple
external_id * external identifier generated by concatenating and hashing five of the submitted field values [country, report_start, report_end, category, breakdown, reporting_phase, unit_of_measurement, program, reported_source]. This ensures that identical records always produce the same UID, to enable upsert, deduplication operations. * requis	string	c782c9d4731f26d3d040d6a4a24ebd66
country * Two-letter country code as per ISO 3166-1 alpha-2 standard representing the country of the report. * requis	string	RW
reporting_phase * Unique identifier for the reporting phase, typically a sequential alpha-numeric code. It helps us identify the ASCENT phase or project that the reported data belongs to. * requis	string	P001
report_start * Start date of the reporting period. * requis	date	2023-01-01
report_end * End date of the reporting period. * requis	date	2023-01-31
category * Category of the report, indicating whether it pertains to connections or non-connections metrics. * requis	enum: connections, non-connections	connections
unit_of_measurement * Unit of measurement for the metrics reported, such as kWh, number of connections, etc. * requis	string	number
breakdown * JSON object providing the breakdown of the reported record. Includes details such as connection type, end-user type, and the gender of the household head or business owner. * requis	jsonb	{"type": "Grid", "end_user_type": "residential", "primary_responsible_person_gender": "M"}
value * The value of the metric being reported, such as the number of connections, total energy consumed, or any other relevant metric. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. * requis	float	100.0
reported_source * The source of the value, indicating where the value was obtained from, example: Utility, company, contractor, etc or Odyssey. This helps in identifying the origin of the data and ensuring its validity. * requis	string	Utility
program * This helps us extend the use cases for this table by linking it to the program under which the report was submitted, helping to categorize the data and link it to specific programs. * requis	string	ASCENT
last_source_id Id of the last Source which updated the record Généré automatiquement	integer	33
last_import_id Id of the last import which updated the record Généré automatiquement	integer	337
data_origin Origin of the data, generic or name of the api Généré automatiquement	string	generic
custom Saves additional imported data out of standard structure Généré automatiquement	jsonb	{ "some": "key" }
organization_id References Organization of data Généré automatiquement	integer	1
import_id References Import of data Généré automatiquement	integer	1
source_id References Source of data Généré automatiquement	integer	1
updated_at Timestamp when row was updated Généré automatiquement	datetime	2021-05-03 6:23:55
created_at Timestamp when row was inserted Généré automatiquement	datetime	2021-05-03 6:23:55
uid Unique identifier of a single reported metric for a given period, generated by concatenating the following fields: [organization_id, source_id and external_id]. Généré automatiquement	string	123_12_c782c9d4731f26d3d040d6a4a24ebd66