/segmentfault/tags

POST /api/segmentfault/tags

Price: 1 credit

Get one SegmentFault tag by name or URL: its description and wiki text, follower count, related tags, and the users who gained the most reputation in it all time and this month

How to use it

Tag names are the site's own vocabulary, often Chinese; take them from segmentfault/tags/list or the `tags` of a question or article. The tag's questions and articles come from segmentfault/tags/questions and segmentfault/tags/articles.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tag string required — SegmentFault tag name or tag URL (examples: "python", "人工智能", "https://segmentfault.com/t/python")

Response

• @type string (default: "SegmentfaultTagDetail")
• id string required
• name string required
• url string nullable
• description string nullable
• text string nullable
• text_html string nullable
• image string nullable
• icon string nullable
• follower_count integer nullable
• created_at integer nullable
• updated_at integer nullable
• is_edited boolean nullable
• related_tags array (default: [])
  • @type string (default: "SegmentfaultTag")
  • id string nullable
  • name string required
  • url string nullable
  • description string nullable
  • image string nullable
  • icon string nullable
  • content_count integer nullable
  • popularity_score integer nullable
• top_users array (default: [])
  • @type string (default: "SegmentfaultTagTopUser")
  • period string required
  • position integer required
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
  • verified_title string nullable
  • reputation_gained integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No tag with that name Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.