One run's metadata and summary

Metadata and aggregate counts for a single month.

GET

https://res.aireon.ch/res_api/gwr/summary

Authorization

ResApiToken
optional
API key in header

ResApiTokenQuery
optional
API key in query

Query parameters

month
optional
string
Target month 'YYYY-MM'. Defaults to the latest loaded month.

Returns

200

Run metadata.

JSON

month
optional
string
schema_version
optional
integer
generated_at
optional
string
format: date-time
ingested_at
optional
string
format: date-time
feed_file
optional
string
compare_from
optional
string
format: date
compare_to
optional
string
format: date
register_url
optional
string
register_last_modified
optional
string
summary
optional
object
- total
  optional
  integer
- pipeline
  optional
  integer
- likely_minor
  optional
  integer
- register_matched
  optional
  integer
- by_canton
  optional
  map of
  integer
}

401

Missing token.

403

Wrong token.

404

No such month.

One run's metadata and summary

curl --request GET \
  --url https://res.aireon.ch/res_api/gwr/summary \
  --header 'token: <token>'

const url = 'https://res.aireon.ch/res_api/gwr/summary';
const options = {method: 'GET', headers: {token: '<token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "month": "2026-04",
  "schema_version": 0,
  "generated_at": "2019-08-24T14:15:22Z",
  "ingested_at": "2019-08-24T14:15:22Z",
  "feed_file": "string",
  "compare_from": "2019-08-24",
  "compare_to": "2019-08-24",
  "register_url": "string",
  "register_last_modified": "string",
  "summary": {
    "total": 0,
    "pipeline": 0,
    "likely_minor": 0,
    "register_matched": 0,
    "by_canton": {
      "property1": 0,
      "property2": 0
    }
  }
}