Documentation

API

The root endpoint for the data API is https://data.openauburn.org/. The following documentation is strictly for GET requests, as they are the only request type currently supported for public traffic.

Endpoints

All content is returned as a JSON response wrapped as following:

{
    error: "Sample error message, will be null if no errors",
    data: [
        {
            "list": "of"
        },
        {
            "json": "objects"
        }
    ]
  }

Response data is by default delivered on page 1, at 50 records per 'page'. Details on how to adjust pagination can be found in the semantics section.

Datasets

Datasets are reachable at /datasets/[dataset], where the dataset name is as featured on the portal, just lowercase and joined by underscores. For example the dataset "Crime Log" is reachable at /datasets/crime_log/. Individual data points can be selected by calling /datasets/[dataset]/[_id], where _id is a number reflecting the '_id' field on the target record.

Metadata

Metadata for datasets is reachable at / or /metadata. Individual data points can be selected by calling /metadata/[_id], where _id is a number reflecting the '_id' field on the target record.

Query Semantics and Features

This section covers everything following the '?' in your request.

Reserved keys

The following keys provide special functionality, while every other key will be treated as a field name for filtering: show, page, page_size, sort.

Filtering

You can filter by one or more values. You can accomplish this by any of the following:

?field1=value1 -- Returns all data where field1 equals value1
?field1=value1&field1=value2 -- Returns all data where field1 equals value1 or value2
?field1=value1,value2 -- Returns all data where field1 equals value1 or value2

Pagination

You can select page size and the page offset that is returned. Follow the form:
?page=integer -- Determines page number/offset
?page_size=integer

Sorting

You can sort data by any field, ascending or descending. Follow the form:
?sort=field_name,asc -- Sorts data on field_name, ascending.
?sort=field_name,desc -- Sorts data on field_name, descending.

Field Selection

You can show or hide certain fields. It is not reccommended to use both 'show' and 'hide' together.
?show=field1,field2 -- Every record in the response only contains fields field1 and field2.
?hide=field1,field2 -- Every record in the response contains all fields except fields field1 and field2.

Open Auburn