The state of public APIs| Submit an API

|API RANK| by Escape.tech

Benchmark and ranking of 5138+ public APIs by Escape.tech

Back to the list Request ranking update

Canvas Respondent API (ranked 4359 of 5138)

https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/DPscqMy9KCwdybF2ftEM6_canvas_respondent_api_json.json

GENERAL INFORMATION

An API to create respondents and navigate a survey.

Suggested usage in frontend:

Opening a survey:

1. Request `GET /api/surveys/{alias}`

2. Get the customer ID from querystring using `survey.special_questions.customer_id.name`

3. Request `GET /api/respondents/{customer_id}`

4. Set internal state using response

5. Display the last component in the stack to the user

Function to send actions to backend:

1. If there are no actions to send, return

2. Send the list of actions in a `POST /api/respondents/{respondent_id}/batch?exclude_components=` request, where `exclude_components` is a list of components already in memory

3. If successful response and the returned state matches the internal state, remove the sent actions from the internal list

4. If unsuccessful response or the returned state does not match the internal state, show error

Answering a question/answer group:

1. Push `{ "action": "set_answer", "question_id": 1, "answer_

...

SECURITY 4/5

The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.

  • OWASP issues detected: API7:2023

PERFORMANCE 0/5

The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.

  • The median response time of the API is 5,000 ms .

Get p50 under 220 ms to get a 4/5 score.

RELIABILITY 5/5

The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.

  • Self compliance: response objects matched the declared response types.
  • Server errors: the server did not return any 5xx error.

DESIGN 2/5

The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.

  • Respects OpenAPI 3.0.0 schema specification.
  • Contains comments and summaries.
  • Contains examples.
  • Does not contain duplicated objects.

Popularity 0/5

The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!

Last scanned: 5/4/2023