List audits based on filter criteria

post

https://api.brellium.com/v1/audits

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Filter to retrieve audits with

verbose

string | null

enum

controls the level of detail in the response

Allowed:

status

array of strings | null

audit statuses to include

status

set_id

string

question set id

documents

array of strings | null

document ids that the audits were made for

documents

sessionStartDate

date-time | null

start date of the session in ISO format.

sessionEndDate

date-time | null

end date of the session in ISO format

auditStartDate

date-time | null

start date of the audit in ISO format

auditEndDate

date-time | null

end date of the audit in ISO format

scoreLowerBound

float | null

0 to 100

lower bound for the audit score

scoreUpperBound

float | null

0 to 100

upper bound for the audit score

lastUpdatedStartDate

date-time | null

start date of the audit's latest update in ISO format

lastUpdatedEndDate

date-time | null

end date of the audit's latest update in ISO format

page

integer | null

≥ 1

page number

pageSize

integer | null

1 to 1000

number of audits per page

includeDisplayInfo

string | null

enum

include display info

Allowed:

includePeople

string | null

enum

include people

Allowed:

includeTestAudits

string | null

enum

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

Allowed:

includeQuestionIds

string | null

enum

include question ids in the response

Allowed:

includeLastReviewed

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

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json