Raporlama API'si Uç Noktaları

HTTP talebi: GET

https:// [Bölge]/api/v2/clients/[Ally İstemci Kimliği]/reports/overall

[Ally İstemci Kimliği] nizi Ally Kimlik ile değiştirin. Kimliğinizi bilmiyorsanız talep etmek için bir destek bileti oluşturabilirsiniz.

[Bölge] kurumunuzun Ally ortamının barındırıldığı bölgeye bağlı olarak değiştirin:

Yetkilendirme: OAuth taşıyıcı belirteci.

Parametreler: İsteğe bağlı filtreler veya sıralama seçenekleri.

İstek Gövdesi: Yok

Yanıt:

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

HTTP talebi: GET 

https:// [Bölge]/api/v2/clients/[Ally İstemci Kimliği]/reports/overall

[Ally İstemci Kimliği] yerine Ally kimliğinizi girin. Kimliğinizi bilmiyorsanız talep etmek için bir destek bileti oluşturabilirsiniz.

[Bölge] kurumunuzun Ally ortamının barındırıldığı bölgeye bağlı olarak değiştirin:

Yetkilendirme: OAuth taşıyıcı belirteci 

Parametreler: İsteğe bağlı filtreler veya sıralama seçenekleri.

İstek Gövdesi: Yok

Yanıt:

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

Burada;

Ofset - hangi rekor başlangıcından

Limit - ofsetten itibaren kaç kayıt alınır

Sonuçları bir ölçütü göz önünde bulundurarak artan veya azalan düzende sıralanmış olarak görüntülemek isteyip istemediğinizi tanımlayabilirsiniz. Sıralama seçeneği eklemenizi gerektiren durumlarda, sıralama parametresini aşağıda açıklandığı gibi eklemeniz gerekir:

endpoint-URL?sort=<Sort parameter value>

<Parametre değerini Sıralama> aşağıdaki parametre değerlerinden herhangi biri olabilir:

Varsayılan olarak, sonuçlar, artan düzende sıralanır. Farklı bir sıralama yapmak isterseniz şu sıralama parametresini ekleyebilirsiniz:

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

Burada <Order değeri> şu olabilir: asc veya desc

Örnek:

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

Filtreleme seçeneklerini, seçilen ölçütlere bağlı olarak daha az sayıda veya sınırlı sayıda yanıt almak için kullanabilirsiniz. Bir filtreleme seçeneği eklemeniz gerekirse, aşağıda açıklandığı şekilde filtreleme parametresini eklemelisiniz:

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

İki koşul arasına "&" karakterini ekleyerek sıralama ve filtreleme seçeneklerini aynı uç nokta URL'sinde birlikte kullanabilirsiniz. Örneğin, Ally'ın etkinleştirildiği kurslardan kurs adında "test" anahtar sözcüğü geçen ve genel puanın %90'dan küçük olduğu tüm kursları almak istediğinizi varsayalım. URL şöyle görünür:

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

İki filtreleme seçeneğini de kullanabilirsiniz. Örneğin, genel puanı %10 ile %70 arasında olan tüm kursları elde etmeniz gerektiğini varsayalım:

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