Explore Education Statistics API
Mock the Explore Education Statistics API in seconds. This is a draft specification for the upcoming public data API for the EES platform.
[01]
About
Mock the Explore Education Statistics API as a turnkey Mockzilla sim with 15 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. This is a draft specification for the upcoming public data API for the EES platform. Methods: 14x GET, 1x POST. Top resource groups: Data Set, Publication. Hit https://api.justmocks.com/explore-education-statistics for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
15 across 2 resource groups
Methods
GET 14 · POST 1 none deprecated
OpenAPI
3.0.1 spec version 1.0.0
Source spec
61 KB · YAML
[02]
Endpoints
| GET |
/api/v1/publications
|
List publications Lists details about publications with data available for querying. Mocked via Mockzilla.
|
| GET |
/api/v1/publications/{publicationId}
|
Get a publication's details Gets a specific publication's details.
|
| GET |
/api/v1/publications/{publicationId}/data-sets
|
List a publication's data sets Lists summary details of all the data sets related to a publication.
|
| GET |
/api/v1/data-sets/{dataSetId}
|
Get a data set's summary Gets a specific data set's summary details.
|
| GET |
/api/v1/data-sets/{dataSetId}/query
|
Query a data set (GET) Query a data set using a GET request, returning the filtered results. Note that there is a POST variant of this endpoint which provides a more complete set of querying functionality. The GET variant is only recommended for initial exploratory testing or simple queries that do not need advanced functionality. Unlike the POST variant, this endpoint does not allow condition clauses (and, or, not) and consequently cannot express more complex queries.
|
| POST |
/api/v1/data-sets/{dataSetId}/query
|
Query a data set (POST) Query a data set using a POST request, returning the filtered results. Note that for simpler queries or exploratory testing, there is also GET variant of this endpoint which only handles a smaller subset of querying functionality. However, for most use-cases, this endpoint is recommended as it provides the complete set of functionality. Unlike the GET variant, this endpoint allows condition clauses (and, or, not) and consequently can express more complex queries. Available as a Mockzilla mock endpoint.
|
| GET |
/api/v1/data-sets/{dataSetId}/file
|
Get a data set file Get the entire data set in a specified file format.
|
| GET |
/api/v1/data-sets/{dataSetId}/meta
|
Get a data set's metadata Get the metadata about a data set. Use this to create data set queries.
|
| GET |
/api/v1/data-sets/{dataSetId}/meta/filters
|
Get a data set's filter metadata Get the filter metadata about a data set. Use this to create data set queries.
|
| GET |
/api/v1/data-sets/{dataSetId}/meta/indicators
|
Get a data set's indicator metadata Get the indicator metadata about a data set. Use this to create data set queries.
|
| GET |
/api/v1/data-sets/{dataSetId}/meta/geographic
|
Get a data set's geographic metadata Get the geographic metadata about a data set. Use this to create data set queries. Mockzilla mock: no signup, no API key.
|
| GET |
/api/v1/data-sets/{dataSetId}/meta/time-periods
|
Get a data set's time period metadata Get the time period metadata about a data set. Use this to create data set queries.
|
| GET |
/api/v1/data-sets/{dataSetId}/versions
|
List a data set's versions List a data set's versions. Only provides summary information of each version.
|
| GET |
/api/v1/data-sets/{dataSetId}/versions/{dataSetVersion}
|
Get a data set version Get a data set version, including a full list of its changes.
|
| GET |
/api/v1/data-sets/{dataSetId}/versions/{dataSetVersion}/changes
|
Get a data set version's changes Get a data set version's list of changes.
|