History

History collection details

Get the status and progress of the historical data collection job for the topic.

get/topics/{topicId}/history

Request

Base URL
https://api.youscan.io/api/external
Auth
- API key in header X-API-KEY
- or API key in query parameter apiKey
TypeScript
https://skmtc.dev/youscan/apis/youscan-api/docs/topics/:topicId/history/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

topicIdinteger required

ID of the Topic.

Response

History collection job details.

topicIdinteger

Topic ID.

status'collecting' | 'failed' | 'failedComplexQuery' | 'completed' | 'aborted'

Job status.

startedstring date-time nullable

Date and time when the job started.

endedstring date-time nullable

Date and time when the job finished.

fromstring date-time

Date from which data is collected.

tostring date-time

Date until which data is collected.

querystring

Search query used for historical data collection.

processedTostring date-time nullable

Date until which data is already collected.

progressinteger

Percentage completed.

collectedinteger

Number of mentions processed.

savedinteger

Number of mentions saved to the topic.

duplicatesinteger

Number of duplicate mentions skipped.

skippedinteger

Number of mentions skipped.

invalidinteger

Number of invalid mentions.

lastErrorstring nullable

Last error message, if the job failed.

Example response

{
  "topicId": 123,
  "status": "collecting",
  "started": "2021-02-01T13:01:00Z",
  "from": "2021-01-01T00:00:00Z",
  "to": "2021-02-01T00:00:00Z",
  "query": "Tesla or SpaceX",
  "processedTo": "2021-01-15T00:00:00Z",
  "progress": 15,
  "collected": 1024,
  "saved": 900,
  "duplicates": 100,
  "skipped": 20,
  "invalid": 4
}

Changes

No recorded changes to this operation across all 1 revision of this API.