Skip to content

Update from code changes: expanded response fields for takedowns, detections, reports, and assets#98

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6c89fd48
Open

Update from code changes: expanded response fields for takedowns, detections, reports, and assets#98
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6c89fd48

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the additive response fields that ChainPatrol's public REST API and SDK now expose across takedowns, detections, detection configs, reports, and assets.

Changes

  • external-api/takedowns-list.mdx — new "Response fields" section covering externalId, hasFilingDelay, hasLivenessCheckDelay, domainRegistrar, hostingProvider, tldRegistrar, and asset.livenessStatus / asset.blockedAt.
  • external-api/detection-list.mdx — expanded Detection Result table with score, reason, configId, reportedAt, and brands[]; example JSON updated to match.
  • external-api/organization-reports-list.mdx — Response Fields table and example extended with slaDueAt, externalSubmissionLink, duplicateOfId, imageDisplay, favoritedAt, attachments[], and a note on proposals.asset.scans[].
  • external-api/threats-list.mdx — added livenessStatus to the response table, TypeScript interface, and example.
  • external-api/asset-list.mdx — new "Response fields" section highlighting id (now included), livenessStatus, and blockedAt.
  • external-api/asset-search.mdx — overview prose extended to mention livenessStatus and blockedAt on the nested asset object; switched a relative link to a root-relative one.
  • sdk/chainpatrol-client/instance-methods/asset-list.mdx — added id, watchStatus, livenessStatus, and blockedAt to the SDK ResponseField list and example response.

Context

Follows chainpatrol/chainpatrol-web#7087 and chainpatrol/chainpatrol-web#7091, which added these fields to the public API and SDK types. All changes are additive; existing integrations continue to work unchanged.


Note

Low Risk
Changes are documentation only with no runtime or API behavior in this repo; risk is limited to doc accuracy for integrators.

Overview
Docs-only update that describes new additive REST and SDK response fields shipped in chainpatrol-web, so integrators can use them without extra calls.

Assets & threats: asset-list, asset-search, threats-list, and SDK asset.list now document id, livenessStatus, and blockedAt (plus watchStatus on the SDK), with guidance on filtering dead assets and when blockedAt differs from updatedAt.

Detections: detection-list expands each hit with score, reason, configId, reportedAt, and brands[], and clarifies how confidence relates to score.

Reports & takedowns: organization-reports-list adds slaDueAt, externalSubmissionLink, duplicateOfId, imageDisplay, favoritedAt, attachments[], and notes on proposals.asset.scans[]. takedowns-list adds externalId, delay flags, registrar/provider objects, and nested asset liveness/block time.

Minor: asset-search fixes a takedown-tasks doc link to a root-relative path.

Reviewed by Cursor Bugbot for commit e609a11. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
mintlify Bot requested a review from NikitaVr July 7, 2026 13:17
@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
chainpatrol 🔴 Failed Jul 7, 2026, 1:21 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants