Event types available for filtering third parties, dossiers, and documents via the eventName parameter.
Event filtering
The API allows you to filter resources (third parties, dossiers, documents) based on events that occurred. Use the eventName parameter in your requests to filter by event type.
Event Filtering
The Aprovall platform maintains a comprehensive audit log of all significant changes and actions on resources (third parties, dossiers, and documents). Every modification, status change, comment addition, or data update generates an event that is permanently recorded in the system.
The event filtering feature allows you to search for resources based on their activity history. For example, you can find all third parties that had an indicator update within a date range, or all dossiers that transitioned to INVALID status last month.
How It Works
Event filtering requires three parameters that must be provided together:
eventNames - One or more event type codes (e.g.: THIRD_PARTY_ADDED, DOSSIER_STATUS_UPDATED_VALID)
eventOccurrenceStartDate - The start of the time range (ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss)
eventOccurrenceEndDate - The end of the time range (ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss)
When you provide these parameters, the API returns resources that have at least one matching event within the specified date range. Multiple event names are combined with OR logic, meaning the resource will be returned if it has ANY of the specified events during the period.
Use Cases by Resource
Third Parties
Indicator change monitoring: Find all third parties that had an indicator update in the last 30 days:
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_INDICATOR_UPDATED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Tracking additions and archiving: Find all third parties added or archived this month:
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_ADDED,THIRD_PARTY_ARCHIVED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Change synchronization: Retrieve all third parties modified since your last synchronization:
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_UPDATED,THIRD_PARTY_INFORMATION_UPDATED&eventOccurrenceStartDate=2024-01-15T14:30:00&eventOccurrenceEndDate=2024-01-16T14:30:00
Dossiers
Status transition tracking: Find all dossiers that became valid or invalid last month:
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_STATUS_UPDATED_VALID,DOSSIER_STATUS_UPDATED_INVALID&eventOccurrenceStartDate=2023-12-01T00:00:00&eventOccurrenceEndDate=2023-12-31T23:59:59
Monitoring dossiers requiring action: Find all dossiers that moved to "Action required" status this week:
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_STATUS_UPDATED_ACTION_REQUIRED&eventOccurrenceStartDate=2024-01-08T00:00:00&eventOccurrenceEndDate=2024-01-14T23:59:59
Dossier indicator tracking: Find all dossiers with a calculated indicator update:
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_INDICATOR_UPDATED,DOSSIER_CALCULATED_ATTRIBUTE_UPDATED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Documents
Validation tracking: Find all documents whose answer was accepted in Q1 2024:
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_ACCEPTED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-03-31T23:59:59
Invalid document monitoring: Find all documents that moved to invalid status this week:
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_STATUS_UPDATE_INVALID&eventOccurrenceStartDate=2024-01-08T00:00:00&eventOccurrenceEndDate=2024-01-14T23:59:59
New answer tracking: Find all documents that received a new answer today:
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_ADDED,DOCUMENT_ANSWER_UPDATED&eventOccurrenceStartDate=2024-01-15T00:00:00&eventOccurrenceEndDate=2024-01-15T23:59:59
Performance Best Practices
For optimal API performance:
Limit date ranges to reasonable periods (avoid multi-year queries)
Combine event filtering with other criteria to reduce result sets
Use specific event types rather than broad searches
Consider implementing incremental synchronization based on event timestamps
Each resource type (third parties, dossiers, documents) has its own set of event types — refer to the event type reference tables below for the complete list of events available for each resource.
