AdvisorApi
extends AbstractApi
in package
Advisors inspect project content and report insights with metrics and recommendations.
Table of Contents
Methods
- createCheck() : AdvisorCheck|null
- Create Advisor Check
- getCheck() : AdvisorCheck|null
- Get Advisor Check Status
- listInsights() : ModelCollection
- List Advisor Insights
- putApplicationInsight() : mixed
- Create or Update Application Advisor Insight
- updateInsight() : AdvisorInsight|null
- Edit Advisor Insight
Methods
createCheck()
Create Advisor Check
public
createCheck(int $projectId[, array<string|int, mixed> $data = [] ]) : AdvisorCheck|null
Parameters
- $projectId : int
- $data : array<string|int, mixed> = []
-
Omit both keys to re-check every inspector
string $data[category] Can't be used with inspectors
array $data[inspectors] Can't be used with category. List of key and options (mode: auto or all, promptId)
Tags
Return values
AdvisorCheck|nullgetCheck()
Get Advisor Check Status
public
getCheck(int $projectId, string $checkId) : AdvisorCheck|null
Parameters
- $projectId : int
- $checkId : string
Tags
Return values
AdvisorCheck|nulllistInsights()
List Advisor Insights
public
listInsights(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
boolean $params[isDismissed]
string $params[status]
string $params[outcome]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionputApplicationInsight()
Create or Update Application Advisor Insight
public
putApplicationInsight(int $projectId, string $applicationIdentifier, string $moduleKey, array<string|int, mixed> $data) : mixed
Parameters
- $projectId : int
- $applicationIdentifier : string
- $moduleKey : string
-
Key of the application's advisor-inspector module
- $data : array<string|int, mixed>
-
string $data[outcome] required. Enum: "flagged" "clear" "not_applicable"
string $data[checkedAt]
array $data[metrics]
array $data[recommendations]
array $data[payload]
Tags
updateInsight()
Edit Advisor Insight
public
updateInsight(int $projectId, AdvisorInsight $insight) : AdvisorInsight|null
Parameters
- $projectId : int
- $insight : AdvisorInsight
-
Only isDismissed can be changed