API Reference

List audits based on filter criteria

post
https://api.brellium.com/v1/audits
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter to retrieve audits with.

string | null
enum

Controls the level of detail in the response.

Allowed:
status
array of strings | null

Audit statuses to include.

status
string

Question set id.

documents
array of strings | null

Document ids that the audits were made for.

documents
date-time | null

Start date of the session in ISO format.

date-time | null

End date of the session in ISO format.

date-time | null

Start date of the audit in ISO format.

date-time | null

End date of the audit in ISO format.

float | null
0 to 100

Lower bound for the audit score.

float | null
0 to 100

Upper bound for the audit score.

date-time | null

Start date of the audit's latest update in ISO format.

date-time | null

End date of the audit's latest update in ISO format.

integer | null
≥ 1

Page number.

integer | null
1 to 1000

Number of audits per page.

string | null
enum

Include display info.

Allowed:
string | null
enum

Include people.

Allowed:
string | null
enum

If true only test audits are returned, if false or null only non-test audits are returned.

Allowed:
string | null
enum

Include question ids in the response.

Allowed:
string | null
enum

Include last reviewed timestamp in the response - N/A if never reviewed.

Allowed:
flags
array of strings | null

Flags to filter by.

flags
Response

Updated 19 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago