Events API

query fields name returns description events docid\ ol8f8o2lkyibfya1hn7wa retrieves events for a given person or organization eventsbatch docid\ ol8f8o2lkyibfya1hn7wa retrieves events for multiple persons or organizations in a single request info docid\ ol8f8o2lkyibfya1hn7wa returns application information and health status eventsresponse description response containing events for a single person or organization fields name type description events \[event!]! the list of events pageinforesponse pageinforesponse! paging information for the result set event description represents an event associated with a person or organization fields name type description eventid string! an enduring unique id for the event eventdate string! the date that the event actually happened, or will happen deprecated in favor of eventdateinfo eventdateinfo dateinformation! when did the event happen, or when will it happen? eventtype string! what is the event type? (role start announcement, role end announcement, etc) eventtext string! main displayed text for the event personmentions \[personmentions!] all people mentioned in the event organizationmentions \[organizationmentions!] all organizations mentioned in the event eventpublisheddate awsdate! what date was the event first published by altrata? announcementdate string the announcement date deprecated in favor of announcementdateinfo announcementdateinfo dateinformation if the event is an announcement, what was the announcement date? startroletitle string if the event relates to a role start, what is the title of the role that is starting? endroletitle string if the event relates to a role end, what is the title of the role that is ending? dateinformation description represents date information with precision and display format fields name type description date awsdate! the date value dateprecision dateprecision! the precision of the date (day, month, or year) displaydate string! a formatted display string for the date personmentions description represents a person mentioned in an event fields name type description personid string! the unique identifier of the mentioned person personname string! the name of the mentioned person organizationmentions description represents an organization mentioned in an event fields name type description organizationid string! the unique identifier of the mentioned organization organizationname string! the name of the mentioned organization organizationtype string the type of the organization (optional, as a value is not available for all organizations) genericerror description represents a generic error response fields name type description errorcode string! deprecated error code string genericerrorcode genericerrorcode! displays the generic error code correlationid string! an id used to correlate logs and metrics across services and processes errormessage string! a brief description of the issue that occurred error description base error interface for all error types possible types docid\ ol8f8o2lkyibfya1hn7wa docid\ ol8f8o2lkyibfya1hn7wa docid\ ol8f8o2lkyibfya1hn7wa fields name type description errorcode string! deprecated error code string use typed error code instead correlationid string! an id used to correlate logs and metrics across services and processes errormessage string! a brief description of the issue that occurred validationerror description represents a validation error response fields name type description errorcode string! deprecated error code string validationerrorcode validationerrorcode! displays the validation error code correlationid string! an id used to correlate logs and metrics across services and processes errormessage string! a brief description of the issue that occurred errordetails \[errordetail!] deprecated error details list validationerrordetails \[validationerrordetail!]! displays the detailed information about the validation error errordetail description deprecated error detail type use validationerrordetail instead fields name type description message string! displays the description of the error path string represents the area where the error has occurred code string represents the category of error authorizationerror description represents an authorization error response fields name type description errorcode string! deprecated error code string errormessage string! a brief description of the issue that occurred correlationid string! an id used to correlate logs and metrics across services and processes authorizationerrorcode authorizationerrorcode! displays the authorization error code eventsfiltertype description defines the filter types for events values value description announcements n/a eventsbatchresponse description response containing events for multiple persons or organizations fields name type description altrataidevents \[altrataidevents!]! the list of events grouped by altrata id pageinforesponse pageinforesponse! paging information for the result set altrataidevents description represents events associated with a specific altrata id fields name type description altrataid string! the altrata id of the person or organization events \[event!]! the list of events for the requested altrata id inforesponse description contains application information and health status fields name type description appversion string! the current version of the application environment string! the deployment environment name deployment string the deployment identifier healthy boolean! indicates whether the application is healthy correlationid string! an id used to correlate logs and metrics across services and processes permissionsversion string! the current permissions version schemaversion string! the current schema version