Skip to content

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

Open
mintlify[bot] wants to merge 3 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 3 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, and clarify when to use GET /organization/reports versus POST /reports/search.

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[]. Overview prose now explains that the organization can be disambiguated with a slug and cross-references POST /reports/search for asset-content lookups.
  • 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; expanded the SEO description.

Context

Follows chainpatrol/chainpatrol-web#7087 and chainpatrol/chainpatrol-web#7091, which added the response fields to the public API and SDK types, and chainpatrol/chainpatrol-web#7369, which rewrote the OpenAPI descriptions for GET /organization/reports and POST /reports/search to explain when to use each. All changes are additive; existing integrations continue to work unchanged.

Update history

  • Initial pass — documented new response fields on takedowns, detections, reports, and assets (chainpatrol/chainpatrol-web#7087, chainpatrol/chainpatrol-web#7091).
  • SEO pass — expanded the sdk/chainpatrol-client/instance-methods/asset-list.mdx frontmatter description to meet length guidelines.
  • Follow-up — updated the external-api/organization-reports-list.mdx overview to cover the new slug disambiguator and cross-reference POST /reports/search (chainpatrol/chainpatrol-web#7369).

Note

Low Risk
Documentation-only updates describing additive API fields; no application or API behavior changes in this repo.

Overview
Updates external API and SDK docs to match newly exposed, additive response fields across assets, threats, detections, takedowns, and organization reports.

Assets & threats — Documents id, livenessStatus, and blockedAt on asset list/search, threats list, and takedown nested assets, including SDK asset.list response fields and examples.

Detections — Expands the detection result schema with score, reason, configId, reportedAt, and brands[], with updated sample JSON.

Takedowns & reports — Adds takedown-level externalId, delay flags, registrar/hosting objects, and richer organization report fields (slaDueAt, duplicateOfId, attachments, etc.), plus guidance to use POST /reports/search for deduping before filing.

Also fixes a root-relative link in asset-search docs. No runtime code changes.

Reviewed by Cursor Bugbot for commit 1e643b7. 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

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Clarified when to use organization reports list versus reports search, noting the new organization slug parameter.

Source PRs

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