HMhm-courts-and-tribunals-service
reports

Generate an Activity Audit report of user actions within the application register.

Changed on

Creates an asynchronous job to produce a CSV report detailing user activity within the application register, filtered by date range, username, and activity type. Returns an acknowledgement containing the job ID that can be used to track progress and download the report once complete. The CSV output is capped by server configuration, defaulting to 100,000 rows.

post/reports/activity-audit/jobs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /reports/activity-audit/jobs
  • Auth
    none declared

Request body

dateFromstring date required

Inclusive start date (YYYY-MM-DD).

dateTostring date required

Inclusive end date (YYYY-MM-DD).

usernamestring

Exact display username to audit, normally the user's email address.

activityTypesActivityType[] required

One or more activity types to include in the audit report. Must contain at least one value.

Example request

{
  "dateFrom": "2025-10-01",
  "dateTo": "2025-10-31",
  "username": "jsmith@example.com",
  "activityTypes": [
    "UPDATE_APPLICATION"
  ]
}

Response

Report job accepted for asynchronous processing.

idstring uuid required

Unique identifier for the job, in UUID v4 format.

type'ACTIVITY_AUDIT_REPORT' | 'FEES_REPORT' | 'LIST_MAINTENANCE_REPORT' | 'SEARCH_WARRANTS_REPORT' | 'WORKLOAD_REPORT' | 'DURATION_REPORT' | 'PRIVATE_PROSECUTORS_INDEX_REPORT' | 'BULK_UPLOAD_ENTRIES' required

The type of the job being polled by the user.

status'RECEIVED' | 'VALIDATING' | 'PROCESSING' | 'FAILED' | 'COMPLETED' required

The status of the job being polled by the user.

createdCountinteger

Number of applications imported by this job, excluding the CSV header and including subsequently soft-deleted applications. Available only when polling a completed BULK_UPLOAD_ENTRIES job; omitted from all other responses. Counted from retained job-to-application mappings, not the current list size.

mainFeeTotalnumber

Current main fees in GBP for non-deleted applications created by this upload, regardless of payment or remission status. Available only when polling a completed BULK_UPLOAD_ENTRIES job; zero when no applicable fees remain. Calculated on read, so later changes to applications or associated fees can change this value. Omitted from all other responses.

offsiteFeeTotalnumber

Current applicable offsite fees in GBP for non-deleted applications created by this upload, regardless of payment or remission status. Available only when polling a completed BULK_UPLOAD_ENTRIES job; zero when no applicable fees remain. Calculated on read, not an upload-time snapshot. Omitted from all other responses.

totalFeeValuenumber

Sum of mainFeeTotal and offsiteFeeTotal in GBP. Available only when polling a completed BULK_UPLOAD_ENTRIES job. Zero when no applicable fees remain; calculated on read. Omitted from all other responses.

error_descriptionstring

Details of a failed job. Bulk-upload validation failures may include actionable input errors; unexpected bulk-upload processing failures use a generic message and identify the job reference to quote to support.

Example response

{
  "id": "9f7b2a35-57ac-4a1c-9c41-83b6c8157af4",
  "type": "FEES_REPORT",
  "status": "RECEIVED",
  "createdCount": 12,
  "mainFeeTotal": 120.5,
  "offsiteFeeTotal": 30.25,
  "totalFeeValue": 150.75
}

Changes

  • d4587b3d88ecRevision changes
    • info

      added the optional property to the response with the status

  • 50e88f2e5845Revision changes
    • breaking

      removed the enum value ADD_STANDARD_APPLICANT of the request property /

    • breaking

      removed the enum value DELETE_STANDARD_APPLICANT of the request property /

    • breaking

      removed the enum value UPDATE_STANDARD_APPLICANT of the request property /