Feedback parameter definitions

Here are the feedback parameters returned when the feedback endpoint is called. The full and meta columns defines which fields are included based on the feedback query parameter. If it is set to true, you get the full response, and the full column will have a :heavy_check_mark:. If it is set to false or omitted, you receive just the meta data, and Meta column will have an :heavy_check_mark:.

Parameter Definition Full Meta
hash the content hash used to reference the file by Ally as a Service :heavy_check_mark: :heavy_check_mark:
feedback the feedback from processing the document, or null :heavy_check_mark: :heavy_check_mark:
feedback.score score between 0 (low) and 1 (high) indicating the documents accessibility :heavy_check_mark:  
feedback.visibility visibility is the overall accessibility of your document: low, medium, high or perfect :heavy_check_mark:  
feedback.report the contents of the feedback report :heavy_check_mark:  
feedback.report.results the results of the feedback report :heavy_check_mark:  
feedback.report.results.Scanned was the document scanned? :heavy_check_mark:  
feedback.report.results.Scanned.score 0 = scanned, 1 = not scanned :heavy_check_mark:  
feedback.report.results.Tagged is the document tagged? :heavy_check_mark:  
feedback.report.results.Tagged.score 0 = untagged, 1 = tagged :heavy_check_mark:  
feedback.report.results.Ocred was the document OCRed? :heavy_check_mark:  
feedback.report.results.Ocred.score 0 = no, 1 = yes :heavy_check_mark:  
feedback.report.results.AlternativeText report on alternative text for images :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets an array containing locations of detected issues :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets[ ].page the page number containing the issue :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets[ ].y0 the starting y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets[ ].x0 the starting x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets[ ].y1 the ending y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.AlternativeText.snippets[ ].x1 the ending x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.AlternativeText.score alternative text score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.Contrast report on color contrast :heavy_check_mark:  
feedback.report.results.Contrast.snippets an array containing locations of detected issues :heavy_check_mark:  
feedback.report.results.Contrast.snippets[ ].page the page number containing the issue :heavy_check_mark:  
feedback.report.results.Contrast.snippets[ ].y0 the starting y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.Contrast.snippets[ ].x0 the starting x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.Contrast.snippets[ ].y1 the ending y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.Contrast.snippets[ ].x1 the ending x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.Contrast.score contrast score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.HeadingsSequential report on sequential headings :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets an array containing locations of detected issues :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets[ ].page the page number containing the issue :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets[ ].y0 the starting y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets[ ].x0 the starting x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets[ ].y1 the ending y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsSequential.snippets[ ].x1 the ending x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsSequential.score sequential headings score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.HeadingsHigherLevel.snippets report on PDF heading levels :heavy_check_mark:  
feedback.report.results.HeadingsHigherLevel.score higher-level headings score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.Title does the document have a title? :heavy_check_mark:  
feedback.report.results.Title.score 0 = No, 1 = Yes :heavy_check_mark:  
feedback.report.results.TableHeaders report on the existence of headers in tables :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets an array containing locations of detected issues :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets[ ].page the page number containing the issue :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets[ ].y0 the starting y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets[ ].x0 the starting x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets[ ].y1 the ending y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.TableHeaders.snippets[ ].x1 the ending x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.TableHeaders.score table headers score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.LanguagePresence does the document contain language information :heavy_check_mark:  
feedback.report.results.LanguagePresence.score language presence score: 0 = No, 1 = Yes :heavy_check_mark:  
feedback.report.results.HeadingsPresence does the document contain headings? :heavy_check_mark:  
feedback.report.results.HeadingsPresence.score headings present score, 0 = No, 1 = Yes :heavy_check_mark:  
feedback.report.results.LanguageCorrect does the document language declaration match the language used? :heavy_check_mark:  
feedback.report.results.LanguageCorrect.detectedLanguage language code declared, i.e. ‘en’ for English :heavy_check_mark:  
feedback.report.results.LanguageCorrect.score language correct score, 0 = No, 1 = Yes :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne report on headings and whether they start at one :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets an array containing locations of detected issues :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets[ ].page the page number containing the issue :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets[ ].y0 the starting y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets[ ].x0 the starting x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets[ ].y1 the ending y axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.snippets[ ].x1 the ending x axis location on the page of the issue :heavy_check_mark:  
feedback.report.results.HeadingsStartAtOne.score score between 0 (low) and 1 (high) :heavy_check_mark:  
feedback.report.results.LibraryReference Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark:  
feedback.report.results.LibraryReference.score Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark:  
feedback.report.suggestions the portion of the report that displays improvement suggestions :heavy_check_mark:  
feedback.report.suggestions.HeadingsSequential the document’s total score if all headings are made sequential :heavy_check_mark:  
feedback.report.suggestions.Title the document’s total score if the title is added :heavy_check_mark:  
feedback.report.suggestions.TableHeaders the document’s total score if all tables include headers :heavy_check_mark:  
feedback.report.suggestions.HeadingsStartAtOne the document’s total score if all headings hierarchy starts at one :heavy_check_mark:  
feedback.report.suggestions.AlternativeText the document’s total score if all images contain alternative text :heavy_check_mark:  
feedback.report.suggestions.Contrast the document’s total score if all color contrast issues are corrected :heavy_check_mark:  
feedback.report.suggestions.LibraryReference Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark:  
formats not currently used, will always be null :heavy_check_mark: :heavy_check_mark:
metadata document metadata :heavy_check_mark: :heavy_check_mark:
metadata.name the name of the processed file :heavy_check_mark: :heavy_check_mark:
metadata.decorative Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark: :heavy_check_mark:
metadata.description Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark: :heavy_check_mark:
metadata.fileType the file type of the processed file :heavy_check_mark: :heavy_check_mark:
metadata.mimeType the mime type of the processed file :heavy_check_mark: :heavy_check_mark:
metadata.isVersioned Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark: :heavy_check_mark:
metadata.isSeizureInducing will the processed file cause seizures? :heavy_check_mark: :heavy_check_mark:
metadata.libraryReference Deprecated Not used. This will always be null and will be removed in a future release :heavy_check_mark: :heavy_check_mark:

For more information about the Ally accessibility tests, visit the Accessibility Checklist page on help.blackboard.com.