Skip to content

Latest commit

 

History

History
executable file
·
63 lines (48 loc) · 1.52 KB

tag-related.md

File metadata and controls

executable file
·
63 lines (48 loc) · 1.52 KB

API Method: /api/tag/related

flags=comments

Get a list of related tags.

This method does not support pagination, but will return up to 100 related tags.

Parameters

ParameterDescription
tag (required) The tag to return related tags for.

Permission level

The minimum required permission level is:

anonymous

Example XML Response

<response status="ok" permission_level="read" total_count="6" cached="0">
  <relatedtag tag="screencast" url="/tag/screencast"/>
  <relatedtag tag="video" url="/tag/video"/>
  <relatedtag tag="analytics" url="/tag/analytics"/>
  <relatedtag tag="23" url="/tag/23"/>
  <relatedtag tag="statistics" url="/tag/statistics"/>
  <relatedtag tag="upload" url="/tag/upload"/>
</response>

Example JSON Response

{
  "status": "ok", 
  "permission_level":"read",
  "cached":"0",
  "relatedtags":[
      {"tag": "screencast", "url": "/tag/screencast"},
      {"tag": "video", "url": "/tag/video"},
      {"tag": "analytics", "url": "/tag/analytics"},
      {"tag": "23", "url": "/tag/23"},
      {"tag": "statistics", "url": "/tag/statistics"},
      {"tag": "upload", "url": "/tag/upload"}
    ],
  "p": "1",
  "size": "1",
  "total_count": "6",
  "site": { ... },
  "endpoint": "/api/tag/related"
}