Extrems de l'API d'informes

Sol·licitud HTTP: GET

https:// [Region]/api/v2/clients/[Ally Client ID]/reports/overall

Substituïu [Ally Client ID] amb el vostre identificador d'Ally. Si no sabeu quin és el vostre ID, podeu crear un tiquet d'assistència per sol·licitar-lo.

Substituïu [Region] depenent de la regió on s'allotja l'entorn Ally de la vostra institució:

Autorització: testimoni de portador d'OAuth.

Paràmetres: filtres opcionals o opcions d'ordenació.

Cos de la sol·licitud: cap

Resposta:

{ 
    "data": [ 
        { 
            "application/x-quiz": 2, 
            "observedDeletedOn": "", 
            "termName": "Fall 2016", 
            "courseId": "1", 
            "application/x-announcement": 0, 
            "image": 4, 
            "termId": "2", 
            "document": 93, 
            "allyEnabled": true, 
            "pdf": 74, 
            "courseCode": "BIO101", 
            "application/x-assignment": 0, 
            "departmentId": "1", 
            "totalFiles": 192, 
            "courseUrl": "https://ally.instructure.com/courses/1", 
            "departmentName": "Anthology Ally", 
            "application/x-page": 1, 
            "filesScore": 0.6022810739019293, 
            "application/x-syllabus": 1, 
            "numberOfStudents": 1, 
            "html-page": 5, 
            "lastCheckedOn": "2022-04-13 15:33:23", 
            "WYSIWYGScore": 1.0, 
            "totalWYSIWYG": 5, 
            "courseName": "Biology 101", 
            "application/x-discussion-topic": 1, 
            "other": 11, 
            "overallScore": 0.6129724428830603, 
            "presentation": 5 
        } 
], 
    "metadata": {
    "filteredTotal": 0,
    "total": 7186,
        "to": 7186,
    "status": "Processing", 
        "from": 1 
    } 
} 

Sol·licitud HTTP: GET 

https:// [Region]/api/v2/clients/[Ally Client ID]/reports/overall

Substituïu [Ally Client ID] amb el vostre ID d'Ally. Si no sabeu quin és el vostre ID, podeu crear un tiquet d'assistència per sol·licitar-lo.

Substituïu [Region] depenent de la regió on s'allotja l'entorn Ally de la vostra institució:

Autorització: testimoni de portador d'OAuth 

Paràmetres: filtres opcionals o opcions d'ordenació.

Cos de la sol·licitud: cap

Resposta:

{ 
    "data": [ 
        { 
            "imageDecorative2": 4, 
            "htmlEmptyHeading2": 0, 
            "imageSeizure1": 2, 
            "observedDeletedOn": "", 
            "htmlObjectAlt2": 0, 
            "security1": 3, 
            "termName": "Fall 2016", 
            "courseId": "1", 
            "languageCorrect3": 14, 
            "htmlColorContrast2": 2, 
            "htmlLinkName3": 0, 
            "termId": "2", 
            "languagePresence3": 10, 
            "allyEnabled": true, 
            "htmlLabel2": 0, 
            "alternativeText2": 68, 
            "htmlImageAlt2": 0, 
            "htmlImageRedundantAlt3": 0, 
            "headingsPresence2": 20, 
            "courseCode": "BIO101", 
            "headingsSequential3": 4, 
            "departmentId": "1", 
            "htmlHeadingsPresence2": 0, 
            "courseUrl": "https://ally.instructure.com/courses/1", 
            "headingsStartAtOne3": 4, 
            "departmentName": "Anthology Ally", 
            "htmlHeadingsStart2": 0, 
            "htmlTdHasHeader2": 0, 
            "htmlList3": 0, 
            "htmlDefinitionList3": 0, 
            "htmlCaption2": 0, 
            "tableHeaders2": 23, 
            "htmlEmptyTableHeader2": 0, 
            "htmlHasLang3": 1, 
            "ocred2": 0, 
            "scanned1": 6, 
            "htmlBrokenLink2": 0, 
            "numberOfStudents": 1, 
            "htmlHeadingOrder3": 0, 
            "lastCheckedOn": "2022-04-13 15:33:23", 
            "headingsHigherLevel3": 0, 
            "contrast2": 28, 
            "title3": 46, 
            "imageOcr3": 0, 
            "tagged2": 4, 
            "libraryReference": 172, 
            "courseName": "Biology 101", 
            "imageContrast2": 0, 
            "imageDescription2": 4, 
            "htmlTitle3": 1, 
            "parsable1": 2 
        } 
], 
    "metadata": { 
        "filteredTotal": 0,
    "total": 7186,
        "to": 7186,
    "status": "Processing", 
        "from": 1 
    } 
} 

On:

Desplaçament: a partir del qual comença el registre

Límit: quants registres es recuperen començant des del desplaçament

Podeu definir si voleu mostrar els resultats ordenats en ordre ascendent o descendent tenint en compte un criteri. Si necessiteu afegir una opció d'ordenació, heu d'afegir el paràmetre d'ordenació tal com es descriu a continuació:

endpoint-url?sort=<Valor del paràmetre d'ordenació>

On <valor del paràmetre d'ordenació> pot ser qualsevol dels valors de paràmetre següents:

Per defecte, els resultats s'ordenen en ordre ascendent. Si voleu establir un ordre diferent, podeu afegir el paràmetre order:

endpoint-url?sort=<Sort parameter value>&order=<Order value>

On <Valor de l'ordre> pot ser: asc o desc

Exemple:

https://prod.ally.ac/api/v2/clients/0/issues?sort=courseName&order=desc

Podeu utilitzar opcions de filtratge per obtenir respostes més petites o reduïdes en funció dels criteris seleccionats. Si necessiteu afegir una opció de filtratge, heu d'afegir el paràmetre de filtratge tal com es descriu a continuació:

https://prod.ally.ac/api/v2/clients/15/reports/overall?courseName=co:tests 

Podeu combinar les opcions d'ordenació i filtratge al mateix URL de l'extrem afegint el caràcter "&" entre les dues condicions. Per exemple, suposem que voleu recuperar tots els cursos que contenen la paraula clau "prova" al nom del curs on Ally està habilitat i que la puntuació global és inferior al 90 %. L'URL tindria aquest aspecte:

https://prod.ally.ac/api/v2/clients/0/overall?courseName=co:test&allyEnabled=true&overallScore=lt:0.9

També podeu utilitzar dues opcions de filtratge. Per exemple, suposem que heu d'obtenir tots els cursos que tenen una puntuació global entre el 10 % i el 70 %:

https://prod.ally.ac/api/v2/clients/0/reports/overall?overallScore=ge:0.1&overallScore=le:0.7