Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newcastle University Timeseries API

There may be more than one timeseries associated with a feed, provided for convenience. Ordinarily there will be a plain timeseries, representing raw data from the device. In some cases, there may then be additional timeseries representing converted values (e.g. scaled), corrected, or aggregated temporally.

Newcastle University Timeseries API is one of 8 APIs that Newcastle University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Timeseries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 2.0a.

Requests are made against a single base URL, https://api.usb.urbanobservatory.ac.uk/api/v2.0a.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0a
Base URL
https://api.usb.urbanobservatory.ac.uk/api/v2.0a
Contact
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Timeseries 2

There may be more than one timeseries associated with a feed, provided for convenience. Ordinarily there will be a plain timeseries, representing raw data from the device. In some…

GET
/api/v2.0a/sensors/timeseries/{id}
Request a single timeseries by its unique ID
TimeseriesController.getOne 1 param → 200400
GET
/api/v2.0a/sensors/timeseries/{id}/historic
Request historic data from a timeseries by its unique ID and a date range
TimeseriesController.getHistoric 4 params → 200400403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Timeseries (8 properties), TimeseriesEntry (6 properties), Link (3 properties), BadRequest (3 properties). Each schema is shown below with its type and property counts.

TimeseriesEntry
object
A historic entry associated with a timeseries and a time.
6 properties
Forbidden
object
The requested data could not be returned, because permissions do not permit.
3 properties
Unit
object
The units associated with the values held in the timeseries.
2 properties
Storage
object
The storage mechanism used to hold the data internally.
3 properties
BadRequest
object
An invalid ID or query parameter was used to request information, such as an ID not in the [UUID syntax](https://en.wikipedia.org/wiki/Universallyuniqueidentif…
3 properties
Timeseries
object
8 properties
Link
object
A link provided for [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) purposes, to the item itself or an associated API method.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-timeseries-api-openapi.yml Raw ↑

Other APIs Newcastle University publishes across the network.

Digitised Objects Repository Search and Data API
ECPPEC Electoral Data API
data.ncl Research Data Repository (Figshare)
EPrints Institutional Repository (OAI-PMH)
Newcastle University Entity API
Newcastle University Feed API
Newcastle University Summary API