Documentation: targets
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
Required | Type | p14n | Blurred | Autogenerated | Example | |
---|---|---|---|---|---|---|
metric The specific metric for which the target is set. |
✓ | string | ⤫ | ⤫ | ⤫ |
People provided with new or improved electricity service |
target_value The target value for the specified metric. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | float | ⤫ | ⤫ | ⤫ |
100.0 |
unit_of_measurement Unit of measurement for the metric being tracked, such as kWh, number of connections, etc. |
✓ | string | ⤫ | ⤫ | ⤫ |
number |
effective_date The date when the target was effective. |
✓ | date | ⤫ | ⤫ | ⤫ |
2023-01-01 |
country Two-letter country code as per ISO 3166-1 alpha-2 standard representing the country of the report. |
✓ | 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. |
✓ | string | ⤫ | ⤫ | ⤫ |
P001 |
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. |
✓ | string | ⤫ | ⤫ | ⤫ |
ASCENT |
program_end_date The end date of the program for which the target is set. |
✓ | date | ⤫ | ⤫ | ⤫ |
2030-12-31 |
uid Unique identifier of a single target entry generated by concatenating the following fields: [organization_id, source_id and external_id]. |
⤫ | string | ⤫ | ⤫ | ✓ |
123_12_c782c9d4731f26d3d040d6a4a24ebd66 |
external_id External identifier generated by concatenating and hashing multiple fields: [metric, effective_date, country, reporting_phase, program]. This ensures that identical records always produce the same UID, to enable upsert and deduplication operations. |
⤫ | string | ⤫ | ⤫ | ✓ |
c782c9d4731f26d3d040d6a4a24ebd66 |
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 |