Analyses APIs promoted to beta stability
The Analyses APIs have been promoted from alpha to beta stability. This includes changes to a number of endpoints, as well as behavior changes to existing endpoints. Expand for more details.
What’s changing?
The Analyses APIs are being promoted from alpha to beta stability! As a part of this promotion, there are a number of changes being made to allow integrations to work with analyses more effectively. Notably:
- Files and datasets have been made top-level resources instead of sub-resources of Analyses
- The
analysis-step-dataendpoint (along with the step data object) have been restructured into the analysis step - Request and response bodies have been updated to be more intuitive and easier to use
The following is a listing of all alpha endpoints, along with the corresponding beta endpoints (if any). For a description of schema-level changes, check out our reference documentation
| Alpha Endpoint | Beta Endpoint | Notes |
|---|---|---|
PATCH /v2-alpha/analysis-step-data/{analysis_step_data_id} | N/A | The step data object has been removed in the beta Analyses API. Datasets and files are instead attached directly to analysis steps |
GET /v2-alpha/analysis-steps/{analysis_step_id} | GET /v2-beta/analyses/analysis-steps/{analysis_step_id} | |
PATCH /v2-alpha/analysis-steps/{analysis_step_id} | PATCH /v2-beta/analyses/analysis-steps/{analysis_step_id} | |
POST /v2-alpha/datasets | POST /v2-beta/datasets | Datasets are now a first-class object; datasets endpoints are part of independent Datasets API |
GET /v2-alpha/datasets/{dataset_id} | GET /v2-beta/datasets/{dataset_id} | Datasets are now a first-class object; datasets endpoints are part of independent Datasets API |
| N/A | PATCH /v2-beta/datasets/{dataset_id} | New endpoint for updating datasets; Datasets are now a first-class object; datasets endpoints are part of independent Datasets API |
POST /v2-alpha/files | POST /v2-beta/files | Files are now a first-class object; files endpoints are part of independent Files API |
GET /v2-alpha/files/{file_id} | GET /v2-beta/files/{file_id} | Files are now a first-class object; files endpoints are part of independent Files API |
PATCH /v2-alpha/files/{file_id} | PATCH /v2-beta/files/{file_id} | Files are now a first-class object; files endpoints are part of independent Files API |
For more information on how to use the new beta APIs, check out the Analyses Developer Guide.
When is this happening?
The new Analyses, Files, and Datasets APIs are now live in beta! Check them out in our Reference Docs and the Analyses Developer Guide. Please consider migrating to the beta APIs; the alpha Analyses API is still supported now, but will be deprecated in the future.