Skip to content

post.md

Latest commit

 

History

History
129 lines (119 loc) · 13.8 KB

post.md

File metadata and controls

129 lines (119 loc) · 13.8 KB
Raw

Post

A video, note, tweet or article, the same shape on every platform.

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

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 Post ID on the platform.
url string Link to the post.
type string What kind of post it is.
title string | null Title, where the platform has one (videos, notes, articles).
text string Caption, body or description as plain text; articles come as Markdown.
lang string | null Language code, as reported or detected.
published_at string | null When it was published, ISO 8601 in UTC; null only where the source gives no time (wechat_mp.articles.metrics, wechat_channels.videos.metrics, youtube.channels.videos.list with type=short), then listed in meta.unavailable.
author AccountRef Who posted it.
metrics Metrics Counts at fetch time; a count the platform hides is null.
images string[] | null Image URLs for image posts and notes.
hashtags string[] | null Hashtags or topics, without the # sign.
ext object Platform-specific extras. Only returned with view=full.

AccountRef

Field Type Description
id string Account ID on the platform.
username string | null Handle, where the platform has one.
name string | null Display name.
avatar_url string | null Avatar image URL.
followers integer | null Follower count at fetch time.
verified boolean | null Whether the platform shows a verification badge.

Metrics

Field Type Description
views integer | null Views or plays.
likes integer | null Likes.
comments integer | null Comments.
shares integer | null Shares.
favorites integer | null Saves or favorites.
reposts integer | null Reposts, retweets or forwards.

Endpoints that return a Post