Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.97 KB

keyword_related.md

File metadata and controls

26 lines (20 loc) · 1.97 KB

KeywordRelated

A keyword related to the one asked about, how it is related and how big it is.

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

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
keyword string The related keyword.
related_to string The keyword asked about.
relation string | null How it relates: searched together (query), appears together in content (posts), searched before (prior) or after (after), or suggested as you type (suggestion).
rank integer | null Position among the keywords of the same relation, from 1.
relevance number | null How closely it is related, 0 to 1.
search_index integer | null Its search index (the platform's measure, not a count); null where the platform gives none.
composite_index integer | null Its composite index (the platform's measure of attention, not a count).
ext object Platform-specific extras. Only returned with view=full.

Endpoints that return a KeywordRelated