Skip to main content

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 check. If it is set to false or omitted, you receive just the meta data, and Meta column will have an check

ParameterDefinitionFullMeta
hashthe content hash used to reference the file by Ally as a Servicecheckcheck
feedbackthe feedback from processing the document, or nullcheckcheck
feedback.scorescore between 0 (low) and 1 (high) indicating the documents accessibilitycheck
feedback.visibilityvisibility is the overall accessibility of your document: low, medium, high or perfectcheck
feedback.reportthe contents of the feedback reportcheck
feedback.report.resultsthe results of the feedback reportcheck
feedback.report.results.Scannedwas the document scanned?check
feedback.report.results.Scanned.score0 = scanned, 1 = not scannedcheck
feedback.report.results.Taggedis the document tagged?check
feedback.report.results.Tagged.score0 = untagged, 1 = taggedcheck
feedback.report.results.Ocredwas the document OCRed?check
feedback.report.results.Ocred.score0 = no, 1 = yescheck
feedback.report.results.AlternativeTextreport on alternative text for imagescheck
feedback.report.results.AlternativeText.snippetsan array containing locations of detected issuescheck
feedback.report.results.AlternativeText.snippets[ ].pagethe page number containing the issuecheck
feedback.report.results.AlternativeText.snippets[ ].y0the starting y axis location on the page of the issuecheck
feedback.report.results.AlternativeText.snippets[ ].x0the starting x axis location on the page of the issuecheck
feedback.report.results.AlternativeText.snippets[ ].y1the ending y axis location on the page of the issuecheck
feedback.report.results.AlternativeText.snippets[ ].x1the ending x axis location on the page of the issuecheck
feedback.report.results.AlternativeText.scorealternative text score between 0 (low) and 1 (high)check
feedback.report.results.Contrastreport on color contrastcheck
feedback.report.results.Contrast.snippetsan array containing locations of detected issuescheck
feedback.report.results.Contrast.snippets[ ].pagethe page number containing the issuecheck
feedback.report.results.Contrast.snippets[ ].y0the starting y axis location on the page of the issuecheck
feedback.report.results.Contrast.snippets[ ].x0the starting x axis location on the page of the issuecheck
feedback.report.results.Contrast.snippets[ ].y1the ending y axis location on the page of the issuecheck
feedback.report.results.Contrast.snippets[ ].x1the ending x axis location on the page of the issuecheck
feedback.report.results.Contrast.scorecontrast score between 0 (low) and 1 (high)check
feedback.report.results.HeadingsSequentialreport on sequential headingscheck
feedback.report.results.HeadingsSequential.snippetsan array containing locations of detected issuescheck
feedback.report.results.HeadingsSequential.snippets[ ].pagethe page number containing the issuecheck
feedback.report.results.HeadingsSequential.snippets[ ].y0the starting y axis location on the page of the issuecheck
feedback.report.results.HeadingsSequential.snippets[ ].x0the starting x axis location on the page of the issuecheck
feedback.report.results.HeadingsSequential.snippets[ ].y1the ending y axis location on the page of the issuecheck
feedback.report.results.HeadingsSequential.snippets[ ].x1the ending x axis location on the page of the issuecheck
feedback.report.results.HeadingsSequential.scoresequential headings score between 0 (low) and 1 (high)check
feedback.report.results.HeadingsHigherLevel.snippetsreport on PDF heading levelscheck
feedback.report.results.HeadingsHigherLevel.scorehigher-level headings score between 0 (low) and 1 (high)check
feedback.report.results.Titledoes the document have a title?check
feedback.report.results.Title.score0 = No, 1 = Yescheck
feedback.report.results.TableHeadersreport on the existence of headers in tablescheck
feedback.report.results.TableHeaders.snippetsan array containing locations of detected issuescheck
feedback.report.results.TableHeaders.snippets[ ].pagethe page number containing the issuecheck
feedback.report.results.TableHeaders.snippets[ ].y0the starting y axis location on the page of the issuecheck
feedback.report.results.TableHeaders.snippets[ ].x0the starting x axis location on the page of the issuecheck
feedback.report.results.TableHeaders.snippets[ ].y1the ending y axis location on the page of the issuecheck
feedback.report.results.TableHeaders.snippets[ ].x1the ending x axis location on the page of the issuecheck
feedback.report.results.TableHeaders.scoretable headers score between 0 (low) and 1 (high)check
feedback.report.results.LanguagePresencedoes the document contain language informationcheck
feedback.report.results.LanguagePresence.scorelanguage presence score: 0 = No, 1 = Yescheck
feedback.report.results.HeadingsPresencedoes the document contain headings?check
feedback.report.results.HeadingsPresence.scoreheadings present score, 0 = No, 1 = Yescheck
feedback.report.results.LanguageCorrectdoes the document language declaration match the language used?check
feedback.report.results.LanguageCorrect.detectedLanguagelanguage code declared, i.e. 'en' for Englishcheck
feedback.report.results.LanguageCorrect.scorelanguage correct score, 0 = No, 1 = Yescheck
feedback.report.results.HeadingsStartAtOnereport on headings and whether they start at onecheck
feedback.report.results.HeadingsStartAtOne.snippetsan array containing locations of detected issuescheck
feedback.report.results.HeadingsStartAtOne.snippets[ ].pagethe page number containing the issuecheck
feedback.report.results.HeadingsStartAtOne.snippets[ ].y0the starting y axis location on the page of the issuecheck
feedback.report.results.HeadingsStartAtOne.snippets[ ].x0the starting x axis location on the page of the issuecheck
feedback.report.results.HeadingsStartAtOne.snippets[ ].y1the ending y axis location on the page of the issuecheck
feedback.report.results.HeadingsStartAtOne.snippets[ ].x1the ending x axis location on the page of the issuecheck
feedback.report.results.HeadingsStartAtOne.scorescore between 0 (low) and 1 (high)check
feedback.report.results.LibraryReferenceDeprecated Not used. This will always be null and will be removed in a future releasecheck
feedback.report.results.LibraryReference.scoreDeprecated Not used. This will always be null and will be removed in a future releasecheck
feedback.report.suggestionsthe portion of the report that displays improvement suggestionscheck
feedback.report.suggestions.HeadingsSequentialthe document's total score if all headings are made sequentialcheck
feedback.report.suggestions.Titlethe document's total score if the title is addedcheck
feedback.report.suggestions.TableHeadersthe document's total score if all tables include headerscheck
feedback.report.suggestions.HeadingsStartAtOnethe document's total score if all headings hierarchy starts at onecheck
feedback.report.suggestions.AlternativeTextthe document's total score if all images contain alternative textcheck
feedback.report.suggestions.Contrastthe document's total score if all color contrast issues are correctedcheck
feedback.report.suggestions.LibraryReferenceDeprecated Not used. This will always be null and will be removed in a future releasecheck
formatsnot currently used, will always be nullcheckcheck
metadatadocument metadatacheckcheck
metadata.namethe name of the processed filecheckcheck
metadata.decorativeDeprecated Not used. This will always be null and will be removed in a future releasecheckcheck
metadata.descriptionDeprecated Not used. This will always be null and will be removed in a future releasecheckcheck
metadata.fileTypethe file type of the processed filecheckcheck
metadata.mimeTypethe mime type of the processed filecheckcheck
metadata.isVersionedDeprecated Not used. This will always be null and will be removed in a future releasecheckcheck
metadata.isSeizureInducingwill the processed file cause seizures?checkcheck
metadata.libraryReferenceDeprecated Not used. This will always be null and will be removed in a future releasecheckcheck

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

Contributors on this article:

Profile picture of the contributor

Scott Hurrey

Former DirectorIntegrations, Developer Relations and Standards