/qiita/tags

POST /api/qiita/tags

Price: 5 credits

Get Qiita Tag

How to use it

Get a Qiita tag by name or tag page URL. Returns the tag description, icon, article and follower counts, currently trending articles, and the organizations most active under that tag.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tag string required — Tag name or tag page URL (examples: "Python", "https://qiita.com/tags/python")

Response

• @type string (default: "QiitaTag")
• alias string required
• name string nullable
• url string nullable
• image string nullable
• description string nullable
• description_html string nullable
• item_count integer nullable
• follower_count integer nullable
• created_at integer nullable
• updated_at integer nullable
• trend_articles array (default: [])
  • @type string (default: "QiitaArticleBrief")
  • id string required
  • article_title string nullable
  • url string nullable
  • snippet string nullable
  • created_at integer nullable
  • like_count integer nullable
  • author object nullable
    • @type string (default: "QiitaUserRef")
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
  • organization object nullable
    • @type string (default: "QiitaOrganizationRef")
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
  • campaign object nullable
    • @type string (default: "QiitaCampaignRef")
    • id string nullable
    • campaign_title string nullable
    • url string nullable
  • tags array (default: [])
    • @type string (default: "QiitaTagRef")
    • name string required
    • alias string required
    • url string nullable
• top_organizations array (default: [])
  • @type string (default: "QiitaTagOrganizationRank")
  • score integer nullable
  • organization object required
    • @type string (default: "QiitaOrganizationRef")
    • alias string required
    • name string nullable
    • image string nullable
    • url string 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 — Tag not found. Verify the tag 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.