Get
/api/processes/{process}/metrics
Retrieves and formats the metrics configuration for a specific process. Supports different formats like 'student' or default metrics.
Security
OAuth
Laravel passport oauth2 security.
FlowAuthorization Code
Authorization URLhttps://develop-qa.processmaker.net/oauth/authorize
Token URLhttps://develop-qa.processmaker.net/oauth/token
Refresh URLhttps://develop-qa.processmaker.net/token/refresh
Path parameters
process
integerRequired
ID of the process
Query parameters
format
string
Format type of the metrics (e.g., 'student')
Valid values[
"student",
"default"
]
Default"student"
Responses
200
Successful operation
Array of object
object
id
integer
Example1
metric_description
string
ExampleMax amount available
metric_count
integer | null
Example10
metric_count_description
string
ExampleAcross 10 applicants
metric_value
number
Example84000.0
metric_value_unit
string
Examplek
400
Invalid format parameter
object
error
string
ExampleInvalid format parameter