API DocsRESTReport service

GetReport

Retrieve a report.

GET
/api/v1/reports/{reportId}

Path Parameters

reportId
Required
string

curl -X GET "<API_URL>/api/v1/reports/string" \
  -H "Authorization: Bearer <API_KEY>"

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": {},
          "failed": {
            "errorMessage": "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"
  }
}