Run Analytics Controls
POST/runAnalyticsControls
This API is used to run analytics job.
The Authorization
must have Bearer
followed by Token
.
Mandatory params:
jobgroup
,
jobname
,
analyticsCategories
(start and end with ###)
Optional params:
analyticsApplications
analyticssubcategories
(start and end with ###)
Request
- application/json
- application/x-www-form-urlencoded
Body
analyticsidstring
Example:
6
jobgroupstring
Example:
Analytics
jobnamestring
Example:
AnalyticsESJob
Body
analyticsCategoriesstring
Example:
###Usage###
analyticssubcategoriesstring
Example:
###testsub###
jobgroupstring
Example:
Analytics
jobnamestring
Example:
AnalyticsJob
Responses
- 200
Run Analytics Controls / Run Analytics Controls with analyticssubcategories / Run Analytics Controls ES
Response Headers
Access-Control-Allow-Credentials
string
Access-Control-Allow-Origin
string
Cache-Control
string
Date
string
Expires
string
Referrer-Policy
string
Server
string
Set-Cookie
string
Strict-Transport-Security
string
X-Content-Type-Options
string
- application/json
- Schema
- Example (from schema)
- Run Analytics Controls
- Run Analytics Controls ES
- Run Analytics Controls with analyticssubcategories
Schema
errorCodestring
Example:
0
msgstring
Example:
Job started successfully
{
"errorCode": "0",
"msg": "Job started successfully"
}
{
"errorCode": "0",
"msg": "Job started successfully"
}
{
"errorCode": "0",
"msg": "Job started successfully"
}
{
"errorCode": "0",
"msg": "Job started successfully"
}