rfcx / rfcx-api

Core, Media/Assets and MQTT APIs
https://api.rfcx.org/docs/
Apache License 2.0
0 stars 0 forks source link

Add params to Classifier job summary endpoints #568

Closed Tooseriuz closed 6 months ago

Tooseriuz commented 6 months ago

✅ DoD

(use na when API docs (Release notes, etc) do not need to be updated)

📝 Summary

📸 Examples

current summary
(Gunshot, 7, 2, 1, 1)
(Live, 20, 5, 6, 7)
(Animalia, 10, 7, 5, 6)
(Cnidaria, 50, 4, 6, 8)
(Anthozoa, 30, 18, 2, 9)
(Scleractinia, 40, 5, 12, 29)
(Agariciidae, 60, 40, 2, 10)

GET /classifier-job/:id/summary?limit=1

{
    "reviewStatus": {
        "total": 20,
        "confirmed": 5,
        "rejected": 6,
        "uncertain": 7
    },
    "classificationsSummary": [
        {
            "value": "live",
            "title": "Live",
            "image": null,
            "total": 20,
            "confirmed": 5,
            "rejected": 6,
            "uncertain": 7
        }
    ]
}

GET /classifier-job/:id/summary?offset=2

{
    "reviewStatus": {
        "total": 180,
        "confirmed": 67,
        "rejected": 22,
        "uncertain": 47
    },
    "classificationsSummary": [
        {
            "value": "animalia",
            "title": "Animalia",
            "image": null,
            "total": 50,
            "confirmed": 4,
            "rejected": 6,
            "uncertain": 8
        },
        {
            "value": "cnidaria",
            "title": "Cnidaria",
            "image": null,
            "total": 30,
            "confirmed": 18,
            "rejected": 2,
            "uncertain": 9
        },
        {
            "value": "anthozoa",
            "title": "Anthozoa",
            "image": null,
            "total": 40,
            "confirmed": 5,
            "rejected": 12,
            "uncertain": 20
        },
        {
            "value": "scleractinia",
            "title": "Scleractinia",
            "image": null,
            "total": 60,
            "confirmed": 40,
            "rejected": 2,
            "uncertain": 10
        },
        {
            "value": "agariciidae",
            "title": "Agariciidae",
            "image": null,
            "total": 0,
            "confirmed": 0,
            "rejected": 0,
            "uncertain": 0
        }
    ]
}

GET /classifier-job/:id/summary?sort=name

{
    "reviewStatus": {
        "total": 207,
        "confirmed": 74,
        "rejected": 29,
        "uncertain": 55
    },
    "classificationsSummary": [
        {
            "value": "agariciidae",
            "title": "Agariciidae",
            "image": null,
            "total": 0,
            "confirmed": 0,
            "rejected": 0,
            "uncertain": 0
        },
        {
            "value": "animalia",
            "title": "Animalia",
            "image": null,
            "total": 50,
            "confirmed": 4,
            "rejected": 6,
            "uncertain": 8
        },
        {
            "value": "anthozoa",
            "title": "Anthozoa",
            "image": null,
            "total": 40,
            "confirmed": 5,
            "rejected": 12,
            "uncertain": 20
        },
        {
            "value": "cnidaria",
            "title": "Cnidaria",
            "image": null,
            "total": 30,
            "confirmed": 18,
            "rejected": 2,
            "uncertain": 9
        },
        {
            "value": "gunshot",
            "title": "Gunshot, gunfire",
            "image": null,
            "total": 7,
            "confirmed": 2,
            "rejected": 1,
            "uncertain": 1
        },
        {
            "value": "live",
            "title": "Live",
            "image": null,
            "total": 20,
            "confirmed": 5,
            "rejected": 6,
            "uncertain": 7
        },
        {
            "value": "scleractinia",
            "title": "Scleractinia",
            "image": null,
            "total": 60,
            "confirmed": 40,
            "rejected": 2,
            "uncertain": 10
        }
    ]
}

GET /classifier-job/:id/summary?sort=name&order=DESC

{
    "reviewStatus": {
        "total": 207,
        "confirmed": 74,
        "rejected": 29,
        "uncertain": 55
    },
    "classificationsSummary": [
        {
            "value": "scleractinia",
            "title": "Scleractinia",
            "image": null,
            "total": 60,
            "confirmed": 40,
            "rejected": 2,
            "uncertain": 10
        },
        {
            "value": "live",
            "title": "Live",
            "image": null,
            "total": 20,
            "confirmed": 5,
            "rejected": 6,
            "uncertain": 7
        },
        {
            "value": "gunshot",
            "title": "Gunshot, gunfire",
            "image": null,
            "total": 7,
            "confirmed": 2,
            "rejected": 1,
            "uncertain": 1
        },
        {
            "value": "cnidaria",
            "title": "Cnidaria",
            "image": null,
            "total": 30,
            "confirmed": 18,
            "rejected": 2,
            "uncertain": 9
        },
        {
            "value": "anthozoa",
            "title": "Anthozoa",
            "image": null,
            "total": 40,
            "confirmed": 5,
            "rejected": 12,
            "uncertain": 20
        },
        {
            "value": "animalia",
            "title": "Animalia",
            "image": null,
            "total": 50,
            "confirmed": 4,
            "rejected": 6,
            "uncertain": 8
        },
        {
            "value": "agariciidae",
            "title": "Agariciidae",
            "image": null,
            "total": 0,
            "confirmed": 0,
            "rejected": 0,
            "uncertain": 0
        }
    ]
}

GET /classifier-job/:id/summary?sort=unvalidated

{
    "reviewStatus": {
        "total": 207,
        "confirmed": 74,
        "rejected": 29,
        "uncertain": 55
    },
    "classificationsSummary": [
        {
            "value": "agariciidae",
            "title": "Agariciidae",
            "image": null,
            "total": 0,
            "confirmed": 0,
            "rejected": 0,
            "uncertain": 0
        },
        {
            "value": "cnidaria",
            "title": "Cnidaria",
            "image": null,
            "total": 30,
            "confirmed": 18,
            "rejected": 2,
            "uncertain": 9
        },
        {
            "value": "live",
            "title": "Live",
            "image": null,
            "total": 20,
            "confirmed": 5,
            "rejected": 6,
            "uncertain": 7
        },
        {
            "value": "gunshot",
            "title": "Gunshot, gunfire",
            "image": null,
            "total": 7,
            "confirmed": 2,
            "rejected": 1,
            "uncertain": 1
        },
        {
            "value": "anthozoa",
            "title": "Anthozoa",
            "image": null,
            "total": 40,
            "confirmed": 5,
            "rejected": 12,
            "uncertain": 20
        },
        {
            "value": "scleractinia",
            "title": "Scleractinia",
            "image": null,
            "total": 60,
            "confirmed": 40,
            "rejected": 2,
            "uncertain": 10
        },
        {
            "value": "animalia",
            "title": "Animalia",
            "image": null,
            "total": 50,
            "confirmed": 4,
            "rejected": 6,
            "uncertain": 8
        }
    ]
}