Pontos de extremidade da API de relatórios

Solicitação HTTP: GET

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

Substitua [Código do Cliente Ally] pelo seu código Ally. Se você não souber seu código, crie um chamado de suporte para solicitá-lo.

Substitua a [Region] conforme a região em que o ambiente Ally da sua instituição está hospedado:

Autorização: código do portador do OAuth.

Parâmetros: Filtros opcionais ou opções de classificação.

Corpo do Pedido: Nenhum

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 
    } 
} 

Solicitação HTTP: GET 

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

Substitua o código [Código de cliente do Ally] pelo seu código do Ally. Se você não souber seu código, crie um chamado de suporte para solicitá-lo.

Substitua a [Region] conforme a região em que o ambiente Ally da sua instituição está hospedado:

Autorização: código do portador do OAuth 

Parâmetros: Filtros opcionais ou opções de classificação.

Corpo do Pedido: Nenhum

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 
    } 
} 

Em que:

Deslocamento - de onde o disco começa

Limite - quantos registros são recuperados a partir do desvio

Você pode definir se prefere exibir os resultados classificados em ordem crescente ou decrescente conforme um critério. Se você precisar adicionar uma opção de classificação, adicione o parâmetro de classificação conforme descrito abaixo:

endpoint-url?sort=<Sort parameter value>

Onde <valor do parâmetro Sort> pode ser qualquer um dos seguintes valores de parâmetro:

Por padrão, os resultados são classificados em ordem crescente. se quiser definir uma ordem diferente, pode adicionar o parâmetro de ordem:

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

Onde <valor de ordem> pode ser: asc ou desc

Exemplo:

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

Você pode utilizar as opções de filtragem para obter respostas menores ou reduzidas com base nos critérios selecionados. Se precisar adicionar uma opção de filtragem, deve adicionar o parâmetro de filtragem conforme descrito abaixo:

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

Você pode combinar as opções de classificação e filtragem no mesma URL do ponto de extremidade adicionando o caractere "&" entre as duas condições. Por exemplo, digamos que você queira recuperar todos os cursos que contêm a palavra-chave "test" no nome do curso em que o Ally está habilitado e que tenha pontuação geral inferior a 90%. A URL seria assim:

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

Você também pode utilizar duas opções de filtragem. Por exemplo, digamos que você precise obter todos os cursos que tenham uma pontuação geral entre 10% e 70%:

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