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

YouScan Data Import API

The Data Import API allows you to import mentions from external sources into YouScan topics.This feature enables you to bring historical data or mentions from sources not nativelysupported by YouScan.**Beta Notice**: This API is currently in beta and may undergo minor changes.

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

Tagged areas include Data Import. 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 8 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.

5 operations 4 paths 8 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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 Data Import 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 — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Data Import 5

The Data Import API allows you to import mentions from external sources into YouScan topics. This feature enables you to bring historical data or mentions from sources not nativel…

POST
/topics/{topicId}/imports
Create import
createImport 1 param body → 201400404413401
GET
/topics/{topicId}/imports
List imports
listImports 2 params → 200400404401
GET
/topics/{topicId}/imports/{importId}
Get import status
getImportStatus 2 params → 200404401
POST
/topics/{topicId}/imports/{importId}/abort
Abort import
abortImport 2 params → 200400404401
GET
/topics/{topicId}/imports/{importId}/errors
Get import errors
getImportErrors 2 params → 200404401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ImportMention (22 properties), ImportStatus (14 properties), ImportProfile (10 properties), ImportEngagement (8 properties). Each schema is shown below with its type and property counts.

ImportError
object
5 properties
ImportStatus
object
14 properties
ValidationError
object
3 properties
Error
object
3 properties
ImportMention
object
22 properties 2 required
ImportProfile
object
10 properties
ImportEngagement
object
8 properties
ImportGeo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

youscan-data-import-api-openapi.yml Raw ↑

Other APIs YouScan publishes across the network.

YouScan History API
YouScan Mentions API
YouScan Spaces API
YouScan Statistics API
YouScan Tags API
YouScan Topics API
YouScan Webhook API