{ "openapi": "3.1.0", "info": { "title": "Young people in detention on an average night, by quarter, Australia, 2008 to 2016 query API", "version": "2017-07-25", "summary": "Filter, page and aggregate Young people in detention on an average night, by quarter, Australia, 2008 to 2016 from Australian Institute of Health and Welfare.", "description": "The query API returns only the rows you ask for, as JSON, NDJSON or CSV, from the same typed rows as the files. It needs no key. The API allows 60 requests in 10 seconds from one address. Above that it answers 429 for 10 seconds with a `Retry-After` header, a `RateLimit-Policy` header and a JSON body that gives the limit. Every API answer carries the same `RateLimit-Policy`. A client should wait the `Retry-After` seconds, or read the files, which have no limit. Every JSON answer carries the version, licence and attribution. CSV and NDJSON answers carry them in response headers. Australian Institute of Health and Welfare has not endorsed this site. The whole site is described in https://publicdata.au/openapi.json.", "license": { "name": "CC BY 3.0 AU", "url": "https://creativecommons.org/licenses/by/3.0/au/" } }, "servers": [ { "url": "https://publicdata.au" } ], "externalDocs": { "url": "https://publicdata.au/d/au-youth-detention-population-quarterly/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/au-youth-detention-population-quarterly/rows": { "get": { "tags": [ "query" ], "summary": "Query Young people in detention on an average night, by quarter, Australia, 2008 to 2016", "operationId": "queryRows_au_youth_detention_population_quarterly", "description": "Rows of Young people in detention on an average night, by quarter, Australia, 2008 to 2016 in the newest loaded version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "string. Values: ACT, Aust, NSW, NT, Qld, SA, Tas, Vic, WA.", "examples": [ "eq.WA" ] }, { "name": "quarter", "in": "query", "schema": { "type": "string" }, "description": "date. First day of the last month of the quarter, so June 2008 is the June quarter 2008. From 2008-06-01 to 2016-06-01.", "examples": [ "eq.2016-06-01" ] }, { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016.", "examples": [ "eq.2016" ] }, { "name": "age_group", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 10 to 17, 18+, Total.", "examples": [ "eq.Total" ] }, { "name": "indigenous_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Indigenous, Non-Indigenous, Not stated, Total.", "examples": [ "eq.Total" ] }, { "name": "legal_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Sentenced, Total, Unsentenced.", "examples": [ "eq.Unsentenced" ] }, { "name": "sex", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Female, Male, Total, Unknow.", "examples": [ "eq.Unknow" ] }, { "name": "avg_nightly_population", "in": "query", "schema": { "type": "string" }, "description": "integer. From 0 to 1073." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/au-youth-detention-population-quarterly/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query Young people in detention on an average night, by quarter, Australia, 2008 to 2016", "operationId": "queryRows_au_youth_detention_population_quarterly_version", "description": "Rows of Young people in detention on an average night, by quarter, Australia, 2008 to 2016 in one dated version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "string. Values: ACT, Aust, NSW, NT, Qld, SA, Tas, Vic, WA.", "examples": [ "eq.WA" ] }, { "name": "quarter", "in": "query", "schema": { "type": "string" }, "description": "date. First day of the last month of the quarter, so June 2008 is the June quarter 2008. From 2008-06-01 to 2016-06-01.", "examples": [ "eq.2016-06-01" ] }, { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016.", "examples": [ "eq.2016" ] }, { "name": "age_group", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 10 to 17, 18+, Total.", "examples": [ "eq.Total" ] }, { "name": "indigenous_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Indigenous, Non-Indigenous, Not stated, Total.", "examples": [ "eq.Total" ] }, { "name": "legal_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Sentenced, Total, Unsentenced.", "examples": [ "eq.Unsentenced" ] }, { "name": "sex", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Female, Male, Total, Unknow.", "examples": [ "eq.Unknow" ] }, { "name": "avg_nightly_population", "in": "query", "schema": { "type": "string" }, "description": "integer. From 0 to 1073." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregate", "description": "Groups and totals of any dataset in the newest loaded version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "au-youth-detention-population-quarterly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "string. Values: ACT, Aust, NSW, NT, Qld, SA, Tas, Vic, WA.", "examples": [ "eq.WA" ] }, { "name": "quarter", "in": "query", "schema": { "type": "string" }, "description": "date. First day of the last month of the quarter, so June 2008 is the June quarter 2008. From 2008-06-01 to 2016-06-01.", "examples": [ "eq.2016-06-01" ] }, { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016.", "examples": [ "eq.2016" ] }, { "name": "age_group", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 10 to 17, 18+, Total.", "examples": [ "eq.Total" ] }, { "name": "indigenous_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Indigenous, Non-Indigenous, Not stated, Total.", "examples": [ "eq.Total" ] }, { "name": "legal_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Sentenced, Total, Unsentenced.", "examples": [ "eq.Unsentenced" ] }, { "name": "sex", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Female, Male, Total, Unknow.", "examples": [ "eq.Unknow" ] }, { "name": "avg_nightly_population", "in": "query", "schema": { "type": "string" }, "description": "integer. From 0 to 1073." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions/{version}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregateVersion", "description": "Groups and totals of any dataset in one dated version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "au-youth-detention-population-quarterly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "string. Values: ACT, Aust, NSW, NT, Qld, SA, Tas, Vic, WA.", "examples": [ "eq.WA" ] }, { "name": "quarter", "in": "query", "schema": { "type": "string" }, "description": "date. First day of the last month of the quarter, so June 2008 is the June quarter 2008. From 2008-06-01 to 2016-06-01.", "examples": [ "eq.2016-06-01" ] }, { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016.", "examples": [ "eq.2016" ] }, { "name": "age_group", "in": "query", "schema": { "type": "string" }, "description": "string. Values: 10 to 17, 18+, Total.", "examples": [ "eq.Total" ] }, { "name": "indigenous_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Indigenous, Non-Indigenous, Not stated, Total.", "examples": [ "eq.Total" ] }, { "name": "legal_status", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Sentenced, Total, Unsentenced.", "examples": [ "eq.Unsentenced" ] }, { "name": "sex", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Female, Male, Total, Unknow.", "examples": [ "eq.Unknow" ] }, { "name": "avg_nightly_population", "in": "query", "schema": { "type": "string" }, "description": "integer. From 0 to 1073." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions": { "get": { "tags": [ "query" ], "summary": "The versions loaded for queries, newest first, with the URLs to query each", "operationId": "queryVersions", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "au-youth-detention-population-quarterly" ] }, "description": "The dataset's slug, as in its page URL `/d//`." } ], "responses": { "200": { "description": "Loaded versions with row counts and URLs." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } } } }