Circle V2 API Docs
Preparing search index...
@repo/trpc
routers/metrics/index
metricsRouter
Variable metricsRouter
Const
metricsRouter
:
BuiltRouter
<
{
ctx
:
TRPCContext
;
errorShape
:
DefaultErrorShape
;
meta
:
object
;
transformer
:
false
;
}
,
DecorateCreateRouterOptions
<
{
criteriaAssistants
:
QueryProcedure
<
{
input
:
{
auditTemplateIds
?:
string
[]
;
cursor
?:
number
;
dateRange
:
{
from
:
string
;
to
:
string
}
;
facilityIds
?:
string
[]
;
limit
?:
number
;
offset
?:
number
;
scoreRange
?:
{
max
?:
number
;
min
?:
number
}
;
search
?:
string
;
sortBy
?:
|
"name"
|
"needs_review"
|
"avg_score"
|
"total_reviews"
|
"passed"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
{
audit_template_id
:
string
&
{
__brand
:
"AuditTemplateId"
}
|
null
;
audit_template_name
:
string
;
}
[]
;
}
,
>
;
criteriaDetail
:
QueryProcedure
<
{
input
:
{
auditTemplateId
:
string
;
auditTemplateIds
?:
string
[]
;
cursor
?:
number
;
dateRange
:
{
from
:
string
;
to
:
string
}
;
facilityIds
?:
string
[]
;
limit
?:
number
;
offset
?:
number
;
scoreRange
?:
{
max
?:
number
;
min
?:
number
}
;
search
?:
string
;
sortBy
?:
|
"question"
|
"needs_review"
|
"avg_score"
|
"total_reviews"
|
"passed"
;
sortOrder
?:
"asc"
|
"desc"
;
userId
?:
string
;
}
;
meta
:
object
;
output
:
{
items
:
{
audit_question_id
:
string
&
{
__brand
:
...
}
|
null
;
avg_score
:
string
|
null
;
is_scoreable
:
boolean
;
needs_review
:
string
;
passed
:
string
;
question
:
string
|
null
;
total_reviews
:
string
;
total_rows
:
string
;
}
[]
;
nextCursor
:
number
|
null
;
providers
:
{
provider_name
:
string
;
provider_user_id
:
UserId
}
[]
;
total
:
number
;
}
;
}
,
>
;
metricsFacilities
:
QueryProcedure
<
{
input
:
{
auditTemplateIds
?:
string
[]
;
cursor
?:
number
;
dateRange
:
{
from
:
string
;
to
:
string
}
;
facilityIds
?:
string
[]
;
limit
?:
number
;
offset
?:
number
;
scoreRange
?:
{
max
?:
number
;
min
?:
number
}
;
search
?:
string
;
sortBy
?:
|
"name"
|
"needs_review"
|
"avg_score"
|
"total_reviews"
|
"passed"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
{
attention_rate
:
number
;
facility_id
:
FacilityId
|
null
;
facility_name
:
string
;
pass_rate
:
number
;
total_clients
:
number
;
total_criteria
:
number
;
total_pass
:
number
;
}
[]
;
}
,
>
;
metricsGrouped
:
QueryProcedure
<
{
input
:
{
auditTemplateIds
?:
string
[]
;
cursor
?:
number
;
dateRange
:
{
from
:
string
;
to
:
string
}
;
dimension
:
"client"
|
"provider"
|
"assistant"
;
facilityIds
?:
string
[]
;
limit
?:
number
;
offset
?:
number
;
scoreRange
?:
{
max
?:
number
;
min
?:
number
}
;
search
?:
string
;
sortBy
?:
|
"name"
|
"needs_review"
|
"avg_score"
|
"total_reviews"
|
"passed"
;
sortOrder
?:
"asc"
|
"desc"
;
}
;
meta
:
object
;
output
:
PaginatedResponse
<
{
avg_score
:
string
;
id
:
string
|
null
;
name
:
string
;
needs_review
:
string
;
passed
:
string
;
total_reviews
:
string
;
total_rows
:
string
;
}
,
>
;
}
,
>
;
}
,
>
,
>
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Circle V2 API Docs
Loading...