Page Comparison

...

{
  "project_id": <project_id>,
  "template_id": <template_id>
}

Including Closed Comments

You can also provide an optional parameter in the request body to specify whether or not to include closed comments in the report. By default, closed comments are filtered out in the corrections report. You can add this option like so:

{
  "project_id": <project_id>,
  "template_id": <template_id>,
  "options": {
    "closedComments": <boolean>
  }
}

Filtering Comments By Label

There may be times where you have multiple external statuses pointing to an internal status (e.g. Open and Approved w/

...

Comments both point to the ‘Open’ internal status) and want to filter comments to only show if they have a specific external status.

Beginning with the 2.3.4 Release of EPR, you can add the excludedLabels parameter inside of the ‘options’. This optional parameter will be an array of external status labels that you want to filter the report comments by. If specified, comments whose label matches one of the labels in the array will be excluded from the report. This filter stacks with the ‘closedComments’ option. If the ‘closedComments’ option is set to true and the ‘excludedLabels’ array is specified, the api will first grab all the comments for the project, then filter out those in the excludedLabels.

{
  "project_id": <project_id>,
  "template_id": <template_id>,
  "options": {
    "closedComments": true
    "excludedLabels": ["Open"] // Comments with label 'Open' will be excluded from the report
  }
}

3. Finished!

If the report was successfully created you should see something similar to the following:

...