Select your language

Documentation: targets

This table saves targets data (e.g. for Ascent reports submitted by PIUs, for KPIs agreed upon in a SOLEIL service contract, etc.). It allows for tracking and validation of targets set for various metrics.
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
Row Name Type Example

metric *

The specific metric for which the target is set.

  • required
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.

  • required
float

100.0

unit_of_measurement *

Unit of measurement for the metric being tracked, such as kWh, number of connections, etc.

  • required
string

number

last_source_id

Id of the last Source which updated the record

  • auto-generated
integer

33

last_import_id

Id of the last import which updated the record

  • auto-generated
integer

337

data_origin

Origin of the data, generic or name of the api

  • auto-generated
string

generic

custom

Saves additional imported data out of standard structure

  • auto-generated
jsonb

{ "some": "key" }

organization_id

References Organization of data

  • auto-generated
integer

1

import_id

References Import of data

  • auto-generated
integer

1

source_id

References Source of data

  • auto-generated
integer

1

updated_at

Timestamp when row was updated

  • auto-generated
datetime

2021-05-03 6:23:55

created_at

Timestamp when row was inserted

  • auto-generated
datetime

2021-05-03 6:23:55

program_end_date

In the case of program supplied, the end date of the program.

 date

2030-12-31

program

Allows linking a target to a program.

string

ASCENT

reporting_phase

Allows linking a target to a reporting_phase.

string

P001

country

Allows linking a target to a country. Two-letter country code as per ISO 3166-1 alpha-2 standard.

 string

RW

effective_from

The moment from which the target applies, if relevant.

 datetime

2023-01-01T00:00:00+00:00

start_value

The value the metric stood at when the project started, from which progress toward target_value is measured, e.g. the baseline of an ASCENT PAD.

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float

0.0

external_id

External identifier, hashed from the fields that tell one target from another, which fields those are being determined by the caller. Any field left out of the build cannot tell two targets apart, so a target differing only by it is the same one reported again, and replaces it. For example, including effective_from keeps a revised target beside the one before it, while leaving it out replaces it (eg. SOLEIL includes it while ASCENT leaves it out).

  • auto-generated
string

c782c9d4731f26d3d040d6a4a24ebd66

uid

Unique identifier of a single target entry generated by concatenating the following: [organization_id external_id].

  • auto-generated
string

123_c782c9d4731f26d3d040d6a4a24ebd66

Progress