Deprecated Endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint allows you to fetch audit logs from your rule solver, including metadata of the solver run as well as the input and output data.
The rule solver does not generate audit logs by default. If you want some rule to generate audits on each solve, you have to turn on audit logs in its Rule Settings. More information can be found on the Audit Logging Page.
There can be a lot of audit logs in the database, of course. We therefore enforce a maximum page size, e.g. the number of audit logs that can be returned per one request. The maximum page size is 1.000, which means that you can never get more audits than 1.000 per one call.
You can choose a custom page size smaller than 1.000 by defining the page_size query parameter. For example, if you set page_size=100, the API will always return maximum 100 audits per request, no matter how many matching audits there are in the database. If not set, the page size defaults to 1.000.
To get more audit logs than those that can fit on one page, you can use the page parameter. For example, if you set page_size=100&page=2, you will get audits 101 - 200, while a request with page_size=100&page=3 yields audits 201 - 300. etc. If not set, page defaults to 1 so you get the first page.
You can also specify the total limit on the number of audits by setting the limit parameter. If set, the API will never fetch any further audits than that with index equal to the limit. For example, a request with page_size=100&page=2&limit=150 yields only the audits 101 - 150, while page_size=100&page=3&limit=150 returns just an empty array of audits because you have exceeded your limit. There is no limit by default.
Request example
You need to copy paste your own Business Intelligence API Key after Bearer . If you do not have it yet, generate your Business Intelligence API Key in the app.
If you cannot send the Business Intelligence API Key inside the authorization header, you may use the bi_key query parameter; e.g. bi_key=DOZpz-h6xnOrKGIINlYvkd9hn41pRR3oG6cqH. In that case, the request could look as follows.
If the bi_key query parameter is not set, the server will look for the authorization header as described above.
/audit
The BI API Key, when not provided in the header
The index of the page of audits
The size of the page (number of audits per request)
The total limit of audits requested
The list of correlation IDs
The list of the solved rules and optionally their versions
The solver keys used to call the rules
The tag list of the solved rules
Lower bound on the date of the solve
Upper bound on the date of the solve
The order in which the audits are returned
Whether debug data should be included within audits
Possible HTTP status codes
/audit
The BI API Key, when not provided in the header
The list of correlation IDs
The list of the solved rules and optionally their versions
Lower bound on the date of the solve
Upper bound on the date of the solve
Possible HTTP status codes
No body