Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.01 KB

topic.md

File metadata and controls

27 lines (19 loc) · 1.01 KB

Topic

A hashtag or topic page and its counts.

Canonical page: https://okdata.online/docs/objects/topic/

The same shape on every platform. A field a platform does not have is null, and meta.unavailable says why. Use fields= to keep only what you need.

Field Type Description
id string ID; pass it as is to the endpoints that take one.
name string Name of the topic.
url string | null Link to the topic page.
description string | null What the topic page says it is about; null when it says nothing.
metrics TopicMetrics Counts at fetch time.
ext object Platform-specific extras. Only returned with view=full.

TopicMetrics

Field Type Description
views integer | null Views of the topic page.
posts integer | null Posts under the topic.

Endpoints that return a Topic