Reading a record
The fields on a record, and how to read status and confidence.
GET /v1/{collection}/{id} returns one record. The collection is organizations, sites, projects or permits.
| Parameter | Default | Effect |
|---|---|---|
response_format | concise | detailed adds the observation time and match method of every value. |
rivals | false | true adds other values that disagree with the served value. |
edge_limit | 50 | How many edges to embed, 0 to 200. Page the rest with /edges. |
Fields
| Field | Meaning |
|---|---|
value | The served value. |
status | confirmed, inferred or derived (below). |
confidence | 0 to 1: how sure Indax is of the value and of its match to this entity. |
rivals | Other values that disagree. Only with rivals=true. |
supporting_sources | How many independent records give the same value. Three agreeing is stronger evidence than one high score. |
updated_at | When the record last changed. Compare it with your cached copy. |
edge_counts | Counts of every edge, including timeline events. "occurred_at:in": 111 means 111 events. |
Status and confidence
Matches at 0.95 and above are confirmed, 0.60 to 0.95 are inferred, and anything below 0.60 is not served.
| You see | What to do |
|---|---|
"status": "confirmed" | Act on it. |
"status": "inferred" | Use it, and flag it as less certain. Example: a link made by distance, within 500 m. |
"status": "derived" | Computed by Indax from other fields, such as sector_tag and every Project field. confidence is null. |
The value "unknown" | The records do not say. It does not mean no. |
| A missing field or edge | No record has it yet. A later daily run may add it. |
When records disagree, the API serves one value and lists the others in rivals. The served value is not always the one with the highest confidence. Matches that are too uncertain are held back, never guessed.