API DocsRESTReport service

CreateReport

Create a report.

POST
/api/v1/reports

Request Body

application/jsonRequired

Deprecated - use RuleEvaluationService instead.

reportFromReportTemplateRequestobject

Deprecated - use RuleEvaluationService instead.

reportFromRulesRequestobject

Deprecated - use RuleEvaluationService instead.

organizationId
Required
string

runId
Required
string

name
Required
string

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

curl -X POST "<API_URL>/api/v1/reports" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "reportFromReportTemplateRequest": {
      "reportTemplateId": "string"
    },
    "reportFromRulesRequest": {
      "name": "string",
      "description": "string",
      "tagNames": [
        "string"
      ],
      "ruleIds": {
        "ruleIds": [
          "string"
        ]
      },
      "ruleClientKeys": {
        "ruleClientKeys": [
          "string"
        ]
      }
    },
    "organizationId": "string",
    "runId": "string",
    "name": "string"
  }'

A successful response.

{
  "report": {
    "reportId": "string",
    "reportTemplateId": "string",
    "runId": "string",
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "summaries": [
      {
        "ruleId": "string",
        "ruleClientKey": "string",
        "ruleVersionId": "string",
        "ruleVersionNumber": 0,
        "reportRuleVersionId": "string",
        "numOpen": 0,
        "numFailed": 0,
        "numPassed": 0,
        "status": "REPORT_RULE_STATUS_UNSPECIFIED",
        "statusDetails": {
          "created": {},
          "live": {},
          "finished": {
            "stdout": "string",
            "stderr": "string"
          },
          "failed": {
            "errorMessage": "string",
            "exitCode": 0,
            "stdout": "string",
            "stderr": "string"
          },
          "canceled": {},
          "error": {
            "errorMessage": "string",
            "exitCode": 0,
            "stdout": "string",
            "stderr": "string"
          }
        },
        "createdDate": "2019-08-24T14:15:22Z",
        "modifiedDate": "2019-08-24T14:15:22Z",
        "assetId": "string",
        "deletedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "tags": [
      {
        "tagName": "string"
      }
    ],
    "rerunFromReportId": "string",
    "jobId": "string",
    "archivedDate": "2019-08-24T14:15:22Z"
  }
}

Previous

CancelReport POST

Next

GetReport GET