Validation Result Types API #

The Validation Result Types API lists the possible outcomes of a label validation, along with how many validations of each type exist. When a user validates a label, they indicate whether they Agree, Disagree, or are Unsure that the label is correct.

Use these result names with the validationResult filter on the Validations API (for example ?validationResult=Agree).

Validation Result Types API Preview #

Below is a live preview of the validation result types and their counts for Project Sidewalk:

Loading validation result types...

Endpoint #

Retrieve a list of all validation result types with their counts.

GET /v3/api/validationResultTypes

Examples#

/v3/api/validationResultTypes Get all validation result types in JSON

Responses#

Success Response (200 OK)#

On success, the API returns an HTTP 200 OK status code and a JSON object containing an array of validation result types.

{
    "status": "OK",
    "validation_result_types": [
        {
            "name": "Agree",
            "count": 152340,
            "count_human": 138210,
            "count_ai": 14130
        },
        {
            "name": "Disagree",
            "count": 38112,
            "count_human": 34890,
            "count_ai": 3222
        },
        {
            "name": "Unsure",
            "count": 9045,
            "count_human": 8530,
            "count_ai": 515
        }
    ]
}

Response Fields #

Field	Type	Description
`status`	`string`	Always "OK" for successful responses.
`validation_result_types`	`array`	Array of validation result type objects.
`validation_result_types[].name`	`string`	Name of the result: "Agree", "Disagree", or "Unsure". Use this with the `validationResult` filter on the Validations API.
`validation_result_types[].count`	`integer`	Total number of validations with this result (human and AI combined).
`validation_result_types[].count_human`	`integer`	Number of validations with this result contributed by human validators.
`validation_result_types[].count_ai`	`integer`	Number of validations with this result contributed by Project Sidewalk AI.

Error Responses#

If an error occurs, the API will return an appropriate HTTP status code and a JSON response body containing details about the error.

500 Internal Server Error: An unexpected error occurred on the server.

Error Response Body #

Error responses include a JSON body with the following structure:

{
    "status": 500, // HTTP Status Code
    "code": "INTERNAL_SERVER_ERROR", // Machine-readable error code
    "message": "Error retrieving validation result types: Database connection error" // Human-readable description
}

Terms of Use #

If you use Project Sidewalk data in your research, please cite the following paper (awarded 🏆 Best Paper at CHI 2019):

Manaswi Saha, Michael Saugstad, Hanuma Teja Maddali, Aileen Zeng, Ryan Holland, Steven Bower, Aditya Dash, Sage Chen, Anthony Li, Kotaro Hara, and Jon Froehlich. 2019. Project Sidewalk: A Web-based Crowdsourcing Tool for Collecting Sidewalk Accessibility Data At Scale. In Proceedings of the 2019 CHI Conference on Human Factors in Computing Systems (CHI '19). Association for Computing Machinery, New York, NY, USA, Paper 62, 1–14.

Contribute#

Project Sidewalk is an open-source project created by the Makeability Lab and hosted on GitHub. We welcome your contributions! If you found a bug or have a feature request, please open an issue on GitHub.

You can also email us at sidewalk@cs.uw.edu

Project Sidewalk in Your City!#

If you are interested in bringing Project Sidewalk to your city, please read our Wiki page.