aVenture APIEntity Classifications Audit

Audit standardized entity classifications across the fleet

View as Markdown

Read-only audit of standardized classification joins across the entity fleet. Pages entities in entityId order with a compact row per entity: join set, multi-primary and ancestor-chain findings, and the set hash the reconcile endpoint requires as expectedHash. Filter by typeRecord, category, minimum join count, or finding.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

cursorstringOptional
Opaque continuation cursor from the previous response's nextCursor. Reuse the same filters and sort.
sizeintegerOptional

The size of the page to be returned; default 25, maximum 200.

Request

This endpoint expects an object.
ancestorChainbooleanOptional

Only entities holding both an ancestor and its descendant code inside one hierarchical standardized category (ISIC, NAICS, SIC); descendant means the ancestor code digits are a strict prefix of the descendant code digits.

categorystring or nullOptional

Restrict to entities holding at least one join in this standardized category; matched rows still report the entity’s full standardized join set.

includePrivateboolean or nullOptional

Privileged read scope for admin callers. Includes hidden and not-yet-published entities. Defaults to private visibility for admin API key or ROLE_ADMIN callers; client-secret callers stay public.

minCountinteger or nullOptional>=1

Only entities with at least this many standardized joins; when omitted, entities with zero joins remain in the fleet audit.

multiplePrimarybooleanOptional
Only entities holding more than one primary join inside a single standardized category.
typeenum or nullOptional
Restrict to entities with this typeRecord, e.g. Company.

Response

OK
rowlist of objects
Audited entities in entityId order.
totalinteger

Frozen snapshot total for fleet audits; keyset pages report page size.

nextCursorstring or nullOptional

Opaque continuation cursor; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error