Skip to main content
POST
/
api
/
v1
/
reports
CreateReport
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reportFromReportTemplateRequest": {
    "reportTemplateId": "<string>"
  },
  "reportFromRulesRequest": {
    "name": "<string>",
    "description": "<string>",
    "tagNames": [
      "<string>"
    ],
    "ruleIds": {
      "ruleIds": [
        "<string>"
      ]
    },
    "ruleClientKeys": {
      "ruleClientKeys": [
        "<string>"
      ]
    }
  },
  "organizationId": "<string>",
  "runId": "<string>",
  "name": "<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>",
    "reportTemplateId": "<string>",
    "runId": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "summaries": [
      {
        "ruleId": "<string>",
        "ruleClientKey": "<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>",
        "deletedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "tags": [
      {
        "tagName": "<string>"
      }
    ],
    "rerunFromReportId": "<string>",
    "jobId": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "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"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Deprecated - use RuleEvaluationService instead.

organizationId
string
required
runId
string
required
name
string
required

Override the name of the report. If not provided, the name will be generated based on the report template or run.

reportFromReportTemplateRequest
object

Deprecated - use RuleEvaluationService instead.

reportFromRulesRequest
object

Deprecated - use RuleEvaluationService instead.

metadata
object[]

Response

A successful response.

Deprecated - use RuleEvaluationService instead.

report
object
required