How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouScan Topics API

Create and manage topics — the monitoring entities that collect mentions matching your queries.### Topic query structureA topic query consists of a `textQuery` and/or `viQuery` (at least one is required) plus an optional `filter`.For all topic query filters, the following field names are supported:- `country`: ISO2 country code (e.g. `country=US`, `country=UA`)- `countryGroup`: Europe, Asia, NorthAmerica, CentralAmerica, TheCaribbean, SouthAmerica, Africa, Oceania (e.g. `countryGroup=Europe`)- `language`: ISO639-2 language code (e.g. `language=ENG`, `language=UKR`)- `source`: domain format (e.g. `source=instagram.com`)- `sourceType`: social, messenger, reviews, news, blog, forum (e.g. `sourceType=social`)- `postType`: post, repost, extendedRepost, comment (e.g. `postType=post`)- `contentType`: text, link, image, video, poll, subtitles, sticker (e.g. `contentType=image`)- `authorAge`: numeric value (e.g. `authorAge=18`)- `authorSubscribers`: numeric value (e.g. `authorSubscribers=1000`)- `gender`: `male` or `female` (e.g. `gender=male`)Supported Visual Insights (VI) query values (used inside `viQuery`):- `logo`: detect specific brand logos (e.g. `logo:"nike"`)- `image.object`: find specific objects (e.g. `image.object:"car"`)- `image.activity`: find activities (e.g. `image.activity:"cooking"`)- `image.person`: find people types (e.g. `image.person:"athlete"`)- `image.scene`: find settings (e.g. `image.scene:"beach"`)- `image.type`: filter by image type (e.g. `image.type:"PHOTO"`)- `image.subtype`: filter by image subtype (e.g. `image.subtype:"selfie"`)- `text`: search mention text (e.g. `text:"sale"`)Supported operations for each filter:- `oneOf`: field value must match one of the specified values. Applicable to most fields.- `notOneOf`: field value must not match any of the specified values. Applicable to most fields.- `greaterOrEqual`: field value must be greater than or equal to the specified value. Numeric fields only (`authorAge`, `authorSubscribers`).- `lessOrEqual`: field value must be less than or equal to the specified value. Numeric fields only (`authorAge`, `authorSubscribers`).Each filter object must specify:- `fieldName`: The field to filter on (see the list above)- `op`: The operation to perform (see the list above)- `value`: JSON-encoded array of values (e.g. `["ua"]`)

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

Tagged areas include Topic. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.youscan.io/api/external.

5 operations 4 paths 6 schemas 1 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.youscan.io/api/external
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

YouScan Topics 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 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Topics 5

Create and manage topics — the monitoring entities that collect mentions matching your queries.

GET
/topics
List topics
listTopics → 200401
POST
/topics
Create topic
createTopic body → 201400402403401
POST
/topics/preview
Preview topic
previewTopic body → 200400401
POST
/topics/{topicId}/query/edit
Update topic query
updateTopicQuery 1 param body → 200400402403404401
DELETE
/topics/{topicId}
Delete topic
deleteTopic 1 param → 200403404401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TopicInfo (4 properties), Error (3 properties), ValidationError (3 properties), TopicQuery (3 properties). Each schema is shown below with its type and property counts.

CustomFilter
object
2 properties
FilterItem
object
3 properties 3 required
TopicQuery
object
Topic query parameters. Either textQuery or viQuery must be set.
3 properties
ValidationError
object
3 properties
Error
object
3 properties
TopicInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

youscan-topics-api-openapi.yml Raw ↑

Other APIs YouScan publishes across the network.

YouScan Data Import API
YouScan History API
YouScan Mentions API
YouScan Spaces API
YouScan Statistics API
YouScan Tags API
YouScan Webhook API
Where this information came from

This is an independent, third-party profile of YouScan Topics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.