Skip to content

Get tenant analysis reports

GET
/v1/tenant/report
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.

tenantName
required
string

The name of the tenant.

type
string
Allowed values: total range

Type of report to retrieve (‘total’ for cumulative, ‘range’ for a date range). Defaults to ‘total’ if omitted.

startTime
string format: date-time

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.

endTime
string format: date-time

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.

Tenant report retrieved successfully

Media typeapplication/json

Standardized success response wrapper for tenant report queries following the APIResponse schema.

object
success
required
boolean
data
required

The tenant report (returned for total/default queries).

object
id

Report document id (ObjectId string).

string
tenantId
required

Tenant id (ObjectId string).

string
updatedAt
required
string format: date-time
startTime
required
string format: date-time
endTime
required
string format: date-time
successfulProcessing
required
object
byType
required
object
api
required

Successful analyses triggered via API.

integer
app
required

Successful analyses triggered via app/frontend.

integer
total
required

Total successful analyses (api + app).

integer
byResult
required
object
fake
required
integer
real
required
integer
uncertain
required
integer
abstain
required
integer
total
required

Total analyses counted in this result aggregation.

integer
confidenceScore
required

Confidence score in range 0..1.

number
<= 1
byModelTypeAndTier
required
object
image
required
object
forensicReporting
required

Number of analyses run with forensic reporting tier.

integer
flagging
required

Number of analyses run with flagging tier.

integer
queuedAnalyses
required
integer
userInteraction
required
object
appLogins
required

Number of frontend logins in the reporting period.

integer
impediments
required
object
processingErrors
required
integer
retries
required
integer
qualityIndicators
required
object
errorRatePercent
required
number
backpressurePercent
required
number
processingDurations
required
object
byModelTypeAndParallelism
required

Average durations grouped by model type and processing parallelism (single/bulk).

object
image
required
object
single
required

Average duration in minutes for single processing mode.

number
nullable
bulk
required

Average duration in minutes for bulk processing mode.

number
nullable
Example
{
"success": true
}

Missing required parameters or invalid date format

Media typeapplication/json

Standardized error response following the APIResponse schema.

object
success
required
boolean
message
required
string
Example
{
"success": false,
"message": "Bad request"
}

Tenant or report not found

Media typeapplication/json

Standardized error response following the APIResponse schema.

object
success
required
boolean
message
required
string
Example
{
"success": false,
"message": "Bad request"
}

Internal server error

Media typeapplication/json

Standardized error response following the APIResponse schema.

object
success
required
boolean
message
required
string
Example
{
"success": false,
"message": "Bad request"
}