Saltar al contenido principal
GET
List organization reports

Descripción general

Obtén los reportes de seguridad de tu organización. Este endpoint devuelve todos los reportes enviados para tu organización, con detalles sobre los Assets (activos digitales: URL, direcciones, perfiles, apps, etc.) reportados, las Proposals (propuestas para bloquear o permitir un asset) y su estado actual. La organización se infiere automáticamente a partir de tu clave de API.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-API-KEY:

Solicitud de ejemplo

Parámetros de consulta

Respuesta

Respuesta exitosa

Campos de la respuesta

Paginación

Usa la paginación basada en cursor para obtener todos los reportes:

Ejemplos de filtros

Filtrar por rango de fechas

Obtén los reportes de un período específico:

Filtrar solo los reportes rechazados

Obtén los reportes que tienen Proposals rechazadas:

Filtrar los reportes que esperan tu revisión

Obtén los reportes que tienen al menos una Proposal a la espera de tu organización: la misma cola que muestra tu página Review:
Cada reporte devuelto trae en proposals[] las Proposals sobre las que hay que actuar. Toma de ahí proposals[].id y proposals[].asset.id y pasa ambos a POST /organization/proposals/{proposalId}/review.

Combinar filtros

Obtén los reportes rechazados de un rango de fechas específico:

Respuestas de error

401 Unauthorized

Se devuelve cuando la clave de API falta, no es válida o no tiene acceso a la organización:

400 Bad Request

Se devuelve cuando los parámetros de consulta no son válidos:

Casos de uso

Monitorear los reportes recientes

Dar seguimiento a los reportes rechazados

Exportar reportes a CSV

Buenas prácticas

Paginación

  • Usa limit=100 para obtener datos en bloque y reducir al mínimo las llamadas a la API
  • Revisa siempre el campo cursor para saber si hay más resultados
  • Guarda el cursor si necesitas retomar la paginación más adelante

Filtros por fecha

  • Usa siempre el formato ISO 8601 para las fechas: YYYY-MM-DDTHH:mm:ss.sssZ
  • Incluye la información de la zona horaria (normalmente UTC con el sufijo Z)
  • Usa startDate y endDate juntos para definir rangos de tiempo precisos

Rendimiento

  • Guarda en caché los datos de los reportes cuando corresponda para reducir las llamadas a la API
  • Usa filtros de fecha para limitar el tamaño del conjunto de resultados
  • Si monitoreas la llegada de reportes nuevos, define intervalos de consulta periódica (se recomiendan de 5 a 10 minutos)

Notas

  • La organización se determina automáticamente a partir de tu clave de API
  • Todas las marcas de tiempo están en formato ISO 8601 con zona horaria UTC
  • El filtro onlyRejected muestra los reportes que tienen al menos una Proposal rechazada, pero el reporte puede contener otras Proposals aprobadas
  • Los reportes se ordenan por fecha de creación (los más recientes primero)
  • El cursor es opaco y no se debe analizar ni modificar

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Parámetros de consulta

limit
number
requerido
Rango requerido: 1 <= x <= 20
cursor
number | null
status
enum<string>
Opciones disponibles:
TODO,
IN_PROGRESS,
CLOSED
searchQuery
string
reporterQuery
string
reporterKind
enum<string>
Opciones disponibles:
human,
automation,
machine_user
reviewerKind
enum<string>
Opciones disponibles:
human,
automation
reviewedByUserId
number | null
startDate
string
endDate
string
updatedAtStartDate
string
updatedAtEndDate
string
registrars
string[]
hasMxRecords
boolean
slug
string
excludeAutomation
boolean
predeterminado:false
onlyRejected
boolean
predeterminado:false
onlyFavorited
boolean
predeterminado:false
reportedByCustomer
boolean
hasAttachments
boolean
needsCustomerReview
boolean
reviewStatuses
enum<string>[]
Opciones disponibles:
APPROVE,
REJECT,
SKIP,
ESCALATE
assetTypes
enum<string>[]
Opciones disponibles:
URL,
PAGE,
ADDRESS,
DISCORD,
LINKEDIN,
TWITTER,
FACEBOOK,
YOUTUBE,
REDDIT,
TELEGRAM,
GOOGLE_APP_STORE,
APPLE_APP_STORE,
AMAZON_APP_STORE,
MICROSOFT_APP_STORE,
TIKTOK,
INSTAGRAM,
THREADS,
MEDIUM,
CHROME_WEB_STORE,
MOZILLA_ADDONS,
OPERA_ADDONS,
EMAIL,
PATREON,
OPENSEA,
FARCASTER,
IPFS,
GOOGLE_FORM,
WHATSAPP,
DISCORD_USER,
QUORA,
GITHUB,
TEACHABLE,
SUBSTACK,
DEBANK,
TAWK_TO,
JOTFORM,
PRIMAL,
BLUESKY,
SNAPCHAT,
DESO,
PINTEREST,
FLICKR,
GALXE,
VELOG,
NPM,
PYPI,
HEX,
DOCKER_HUB,
VOCAL_MEDIA,
TECKFINE,
TENDERLY,
HACKMD,
ETSY,
ZAZZLE,
BASENAME,
BILIBILI_TV,
VIMEO,
DAILYMOTION,
PHONE_NUMBER,
SLACK,
CALENDLY,
NGROK,
RARIBLE,
RUST_PACKAGE,
FLATHUB,
VIDLII,
VEVIOZ,
ISSUU,
SOUNDCLOUD,
ZAPPER,
REDNOTE,
SAMSUNG_APP_STORE,
HUAWEI_APP_STORE,
XIAOMI_APP_STORE,
TENCENT_APP_STORE,
OPPO_APP_STORE,
VIVO_APP_STORE,
F_DROID,
GOOGLE_AD,
BING_AD,
TWITCH,
BEHANCE,
ZORA,
META_AD,
SIGNAL,
DEVIANTART,
BANDCAMP,
ARCHIVE_ORG,
FIVE_HUNDRED_PX,
LUMA,
SMARTMONEYMATCH,
APK_GOLD,
GLASSDOOR,
PUMP_FUN,
TUMBLR,
MASTODON
brandIds
number[]
countryCodes
string[]
Required string length: 2
sources
enum<string>[]
Opciones disponibles:
APP,
API,
CANARY_TOKEN,
AUTO_DETECTION,
ASSET_MANAGEMENT
threatActorIds
number[]

Respuesta

Successful response

reports
object[]
requerido
nextCursor
number | null
requerido
totalCount
number
requerido