Ecoindex
This API provides an easy way to analyze websites with Ecoindex. You have the ability to: - Make a page analysis - Define screen resolution - Save results to a DB - Retrieve results - Limit the number of request per day for a given host This API is built on top of ecoindex-python with FastAPI
Ecoindex endpoints
| Method | Endpoint | Description |
|---|---|---|
| Infra | ||
| GET |
Get_healthcheck_health_get /health |
Check health status of components of the API (database...) |
| Tasks | ||
| DELETE |
Abort_ecoindex_analysis_by_id_v1_tasks_ecoindexes__id__delete /v1/tasks/ecoindexes/{id} |
This aborts one ecoindex task by its id if it is still waiting |
| GET |
Get_ecoindex_analysis_task_by_id_v1_tasks_ecoindexes__id__get /v1/tasks/ecoindexes/{id} |
This returns an ecoindex given by its unique identifier |
| POST |
Add_new_ecoindex_analysis_task_to_the_waiting_queue_v1_tasks_ecoindexes_post /v1/tasks/ecoindexes |
This submits a ecoindex analysis task to the engine |
| Ecoindex | ||
| GET |
Get_ecoindex_analysis_by_id__version__ecoindexes__id__get /{version}/ecoindexes/{id} |
This returns an ecoindex given by its unique identifier |
| GET |
Get_ecoindex_analysis_list__version__ecoindexes_get /{version}/ecoindexes |
This returns a list of ecoindex analysis corresponding to query filters and the given version engine. The results are ordered by ascending date |
| GET |
Get_screenshot__version__ecoindexes__id__screenshot_get /{version}/ecoindexes/{id}/screenshot |
This returns the screenshot of the webpage analysis if it exists |
| Host | ||
| GET |
Get_host_list__version__hosts_get /{version}/hosts |
This returns a list of hosts that ran an ecoindex analysis order by most request made |
Ecoindex pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC Recommended | Free | 10 / second |
|