Reporting API's

There are 5 reporting API’s available. The table below shows the API’s and the associated parameters.

API URL	Parameters	Notes
/core/1.0/API/sessionEvents	startdate – date in YYYY-MM-DD format, inclusive enddate – date in YYYY-MM-DD format, exclusive user – username to search	Returns sessions information (user name, ip address, login date time, duration). Active sessions will not be shown if enddate parameter passed (they have no enddate obviously)
/core/1.0/API/filterRuleEvents	Same as session events API	Returns business rules changes – create, update, delete. Includes user, ip, coverage set details
/core/1.0/API/calculateCoverageEvents	Same as session events API	Shows who and when ran calculate coverage operation
/core/1.0/API/datablockContentRetrieveEvents	Same as session events API	Shows who and when retrieved data through TDO Integration API
/core/1.0/API/dataAssemblyEvents	Same as session event API + projectname - project name to filter projectversion - project version to filter	Returns data assembly summary – how many records were generated, how many rows with errors (error means field wasn’t populated), rows with errors and errors per row.

This API can be sent from an automation tool, such as Postman, or can be run directly in a browser window.

The API format contains the server/port/api information, followed by a question mark and then the parameters.

https://<server>:<port>/<api_url>?parameter1=<value>&parameter2=<value>

As an example, if we were to use the first one, Session events, and wanted to specify a start date of 9/1/24 and for user ‘pvl’ we would format it as follows:

http://99.99.99.99:8080/core/1.0/API/sessionEvents?startdate=2024-09-01&user=pvl

The parameters are optional; if you do not use them you get all events in that category on that server. Parameters allow for filtering the results to the information date range/user range that is desired for reporting.