Skip to main content

​
Overview

As in Step 5 of the first tutorial, let’s generate a Report using the newly created Rule. This time, we will do it using the REST API instead of the UI. The endpoint we will use to generate the report is: EvaluateRules.

​
Generate Report

Run the cURL command below to generate the Report. 
curl -X POST "YOUR_REST_API_URL_HERE/api/v1/rules/evaluate-rules" \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "run": {
      "id": "RUN_ID"
    },
    "allApplicableRules": true,
    "reportName": "fl_demo_report"
  }'
Placeholders
  • Replace YOUR_REST_API_URL_HERE with your REST API URL obtained in the previous step.
  • Replace YOUR_API_KEY_HERE with your API key obtained in the previous step.
  • Replace fl (in fl_demo_report) with your initials.
  • Replace RUN_ID with the Run ID you copied in Step 3.
{
  "createdAnnotationCount": 0, 
  "reportId": "string",
  "jobId": "string"
}

​
View generated Report in Sift

Now that we have generated the Report using the REST API, let’s view the generated Report in Sift.
  1. In Sift, click .
  2. Click the Reports tab.
  3. In the Report name box, enter the name of the Report.
  4. In the Reports table, click the name of the Report.
Generated Report