/zenn/users/comments

POST /api/zenn/users/comments

Price: 5 credits

Get Zenn User Comments

How to use it

List the comments a Zenn user left across articles and scraps, newest first. Each comment comes with its text, like count, whether it is a reply, and the article or scrap it was posted on.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Username or profile URL (examples: "kun432", "https://zenn.dev/kun432")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "ZennUserComment")
• id integer required
• alias string required
• text string nullable
• created_at integer nullable
• updated_at integer nullable
• like_count integer nullable
• is_reply boolean (default: false)
• parent_id integer nullable
• post_type string nullable
• post_owner_id integer nullable
• article object nullable
  • @type string (default: "ZennArticleRef")
  • id integer required
  • alias string required
  • article_title string nullable
  • article_type string nullable (one of: "tech", "idea")
  • emoji string nullable
  • url string nullable
  • published_at integer nullable
  • body_updated_at integer nullable
  • source_repo_updated_at integer nullable
  • like_count integer nullable
  • comment_count integer nullable
  • bookmark_count integer nullable
  • letter_count integer nullable
  • is_pinned boolean (default: false)
  • principal_type string nullable (one of: "User", "Publication")
  • user object nullable
    • @type string (default: "ZennUserRef")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
  • publication object nullable
    • @type string (default: "ZennPublicationRef")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
    • is_pro boolean (default: false)
    • has_avatar boolean (default: false)
• scrap object nullable
  • @type string (default: "ZennScrapRef")
  • id integer required
  • alias string required
  • scrap_title string nullable
  • url string nullable
  • created_at integer nullable
  • last_comment_created_at integer nullable
  • closed_at integer nullable
  • is_closed boolean (default: false)
  • is_noindex boolean (default: false)
  • can_others_post boolean (default: false)
  • comment_count integer nullable
  • like_count integer nullable
  • topics array (default: [])
    • @type string (default: "ZennTopic")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable
    • tagging_count integer nullable
  • user object nullable
    • @type string (default: "ZennUserRef")
    • id integer required
    • 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 — User not found. Verify the username. 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.