Skip to main content
GET
/
api
/
v1
/
reports
/
{reportId}
GetReport
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/reports/{reportId} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

reportId
string
required

Response

A successful response.

The request of a call to ReportService_GetReport to retrieve a report template.

report
object
required