curl --request POST \
--url https://your-sift-api-url.com/api/v1/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"runId": "<string>",
"name": "<string>",
"reportFromReportTemplateRequest": {
"reportTemplateId": "<string>"
},
"reportFromRulesRequest": {
"name": "<string>",
"description": "<string>",
"tagNames": [
"<string>"
],
"ruleIds": {
"ruleIds": [
"<string>"
]
},
"ruleClientKeys": {
"ruleClientKeys": [
"<string>"
]
}
},
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
'{
"report": {
"reportId": "<string>",
"runId": "<string>",
"organizationId": "<string>",
"name": "<string>",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"summaries": [
{
"ruleId": "<string>",
"ruleVersionId": "<string>",
"ruleVersionNumber": 123,
"reportRuleVersionId": "<string>",
"numOpen": 123,
"numFailed": 123,
"numPassed": 123,
"status": "REPORT_RULE_STATUS_UNSPECIFIED",
"statusDetails": {
"created": {},
"live": {},
"finished": {
"stdout": "<string>",
"stderr": "<string>"
},
"failed": {
"errorMessage": "<string>",
"exitCode": 123,
"stdout": "<string>",
"stderr": "<string>"
},
"canceled": {},
"error": {
"errorMessage": "<string>",
"exitCode": 123,
"stdout": "<string>",
"stderr": "<string>"
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"assetId": "<string>",
"ruleClientKey": "<string>",
"deletedDate": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"tagName": "<string>"
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
],
"reportTemplateId": "<string>",
"description": "<string>",
"rerunFromReportId": "<string>",
"jobId": "<string>",
"archivedDate": "2023-11-07T05:31:56Z"
}
}Create a report.
curl --request POST \
--url https://your-sift-api-url.com/api/v1/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"runId": "<string>",
"name": "<string>",
"reportFromReportTemplateRequest": {
"reportTemplateId": "<string>"
},
"reportFromRulesRequest": {
"name": "<string>",
"description": "<string>",
"tagNames": [
"<string>"
],
"ruleIds": {
"ruleIds": [
"<string>"
]
},
"ruleClientKeys": {
"ruleClientKeys": [
"<string>"
]
}
},
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
'{
"report": {
"reportId": "<string>",
"runId": "<string>",
"organizationId": "<string>",
"name": "<string>",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"summaries": [
{
"ruleId": "<string>",
"ruleVersionId": "<string>",
"ruleVersionNumber": 123,
"reportRuleVersionId": "<string>",
"numOpen": 123,
"numFailed": 123,
"numPassed": 123,
"status": "REPORT_RULE_STATUS_UNSPECIFIED",
"statusDetails": {
"created": {},
"live": {},
"finished": {
"stdout": "<string>",
"stderr": "<string>"
},
"failed": {
"errorMessage": "<string>",
"exitCode": 123,
"stdout": "<string>",
"stderr": "<string>"
},
"canceled": {},
"error": {
"errorMessage": "<string>",
"exitCode": 123,
"stdout": "<string>",
"stderr": "<string>"
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"assetId": "<string>",
"ruleClientKey": "<string>",
"deletedDate": "2023-11-07T05:31:56Z"
}
],
"tags": [
{
"tagName": "<string>"
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
],
"reportTemplateId": "<string>",
"description": "<string>",
"rerunFromReportId": "<string>",
"jobId": "<string>",
"archivedDate": "2023-11-07T05:31:56Z"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Deprecated - use RuleEvaluationService instead.
Deprecated - use RuleEvaluationService instead.
Override the name of the report. If not provided, the name will be generated based on the report template or run.
Deprecated - use RuleEvaluationService instead.
Show child attributes
Deprecated - use RuleEvaluationService instead.
Show child attributes
Show child attributes
A successful response.
Deprecated - use RuleEvaluationService instead.
Show child attributes
Was this page helpful?