YouScan Statistics API
Aggregated statistics for mentions of a topic.### Dates`from` and `to` are dates (`yyyy-MM-dd`); `to` is inclusive. Day boundaries arecomputed in the API key owner's time zone (see *Dates and time zones* in the Mentions section).### FiltersAll statistics endpoints accept a common set of optional filters:- `country` (`string[]`): e.g. `country=uk&country=us`- `excludeCountry` (`string[]`): e.g. `excludeCountry=uk&excludeCountry=us`- `sourceTypes` (`string[]`): one of `blog`, `forum`, `news`, `social`, `reviews`, `messenger` (e.g. `sourceTypes=social&sourceTypes=blog`)- `excludeSourceTypes` (`string[]`): same values as `sourceTypes`- `sources` (`string[]`): e.g. `sources=telegram.me&sources=youscan.io`- `excludeSources` (`string[]`): e.g. `excludeSources=telegram.me&excludeSources=youscan.io`- `tags` (`int[]`): filter by tag IDs- `excludeTag` (`int[]`): exclude filter by tag IDsEvery statistics response contains a `totalCount` field — the total number of mentions matching the filters.An unknown or inaccessible `topicId` returns `404` with `message: "Theme not found"`.
YouScan Statistics API is one of 8 APIs that YouScan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Statistics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 13 operations across 13 paths, and defines 5 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 Statistics 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 13
Across 13 paths, the API surfaces 13 operations — 13 GET. Each is listed below with its method, path, parameters, and response codes.
Aggregated statistics for mentions of a topic. Dates from and to are dates (yyyy-MM-dd); to is inclusive. Day boundaries are computed in the API key owner's time zone (see Dates a…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are LinkItem (5 properties), TermWithSentiments (3 properties), ValidationError (3 properties), NameCount (2 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.