Get tenant analysis reports
const url = 'https://api.neuramancer.dev/v1/tenant/report?tenantName=example&type=total';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.neuramancer.dev/v1/tenant/report?tenantName=example&type=total' \ --header 'Authorization: <Authorization>'Returns the total tenant reports (accumulated), a report for a specific date, or reports within a date range. Update policy: Today’s report and the totals are updated in real-time.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The name of the tenant.
Type of report to retrieve (‘total’ for cumulative, ‘range’ for a date range). Defaults to ‘total’ if omitted.
Start time for date range query (ISO format). Defaults to current time if not provided. If equal to endTime, returns the report for that specific day.
End time for date range query (ISO format). Defaults to current time if not provided. If equal to startTime, returns the report for that specific day.
Responses
Section titled “Responses”Tenant report retrieved successfully
Standardized success response wrapper for tenant report queries following the APIResponse
object
The tenant report (returned for total/default queries).
object
Report document id (ObjectId string).
Tenant id (ObjectId string).
object
object
Successful analyses triggered via API.
Successful analyses triggered via app/frontend.
Total successful analyses (api + app).
object
Total analyses counted in this result aggregation.
Confidence score in range 0..1.
object
object
Number of analyses run with forensic reporting tier.
Number of analyses run with flagging tier.
object
Number of frontend logins in the reporting period.
object
object
object
Average durations grouped by model type and processing parallelism (single/bulk).
object
object
Average duration in minutes for single processing mode.
Average duration in minutes for bulk processing mode.
Example
{ "success": true}Missing required parameters or invalid date format
Standardized error response following the APIResponse
object
Example
{ "success": false, "message": "Bad request"}Tenant or report not found
Standardized error response following the APIResponse
object
Example
{ "success": false, "message": "Bad request"}Internal server error
Standardized error response following the APIResponse
object
Example
{ "success": false, "message": "Bad request"}