YouScan History API
Manage historical data collection for a topic.Starting a collection can return `400` if a collection is already running, if the daterange is invalid, or if the requested depth exceeds your plan's history limit.
YouScan History API is one of 8 APIs that YouScan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include History. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.youscan.io/api/external.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
YouScan History API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-API-KEY (ApiKeyHeader).
An API key is passed in the query as apiKey (ApiKeyQuery).
By default, every request must be authenticated.
ApiKeyHeader— API key authentication. The recommended way to authenticate requests.ApiKeyQuery— API key as a query parameter. For testing purposes only.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Manage historical data collection for a topic. Starting a collection can return 400 if a collection is already running, if the date range is invalid, or if the requested depth exc…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are HistoryJobDetails (15 properties), Error (3 properties), ValidationError (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YouScan 7
Other APIs YouScan publishes across the network.