Search Reports

Answers ‘do reports already exist for these specific assets?’. Takes a batch of asset contents, normalizes each one the way ChainPatrol normalizes assets, and returns the reports covering them along with which of your assets each report matched. Use it to avoid filing a duplicate before calling POST /report/create. To browse or filter an organization’s reports instead — by status, asset type, brand, date, review state — use GET /organization/reports, which returns the full report records with pagination.

POST /reports/search

Look up reports by asset content

cURL

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/reports/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assetContents": [
    "<string>"
  ],
  "slug": "<string>",
  "reportedByCustomer": true,
  "limit": 50
}
'

200

{
  "reports": [
    {
      "id": 123,
      "title": "<string>",
      "status": "<string>",
      "reportedByCustomer": true,
      "createdAt": "<string>",
      "assets": [
        "<string>"
      ]
    }
  ],
  "totalCount": 123
}

Overview

Search for existing reports within your organization by asset contents. Use this to check whether a report already exists before creating a new one with Report Create.

Authorizations

X-API-KEY · string · header · required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at [e-mail] to get an API key for your use.

Body

application/json

assetContents · string[] · required

Asset contents to look up — URLs, handles, addresses. Each is normalized the way ChainPatrol normalizes assets, so https://Bad.Site/ matches a report holding the canonical form.

slug · string

Organization slug. Optional for organization-scoped API keys, which resolve the organization from the key itself. Required when your credentials can reach more than one organization.

reportedByCustomer · boolean

limit · integer · default: 50

Maximum number of reports to return, newest first. Defaults to 50, maximum 100. Compare with totalCount to tell whether the results were truncated.

Required range: 1 <= x <= 100

Response

200

application/json

Successful response

reports · object[] · required

Show child attributes

totalCount · number · required

Total number of reports matching the search, ignoring limit. A value greater than reports.length means the results were truncated.