Sign in

v1

latestOpenAPI 3.1.02026-07-242892032.8 MB
Data

Query dataset

Agnitio data queries are performed by assembling a JSON description of the query and POSTing it to the specific dataset you wish to query. The query structure has two required fields: metrics and constraints.

The metrics field is an array of objects which describe which metrics you would like queried and returned. These objects have a required name field which specifies which metric is desired. They also have an optional as field which allows you to determine what the metric is called in the response.

The constraints field is an array of objects which describe how the dimensions of the dataset should be limited and aggregated. The map field in the request constraints maps from the codes defined by the dimension's taxonomy to user defined values that will be returned in the response.

In addition to the map field, you can use a shorthand option as well known as mapLevel to roll out a given parent to all of its children as individual mappings at a specified level.

The API also supports operations like Location Quotient and Shift Share, as well as sorting, offsets, and limits for pagination.

post/{dataset}/{version}

Path parameters

versionstring required

The skills taxonomy version.

Query parameters

dataset'global' | 'global_plus'

Specify dataset to query.

Request body

offsetinteger

Pagination offset

limitinteger

Pagination limit

Example request

{
  "metrics": [
    {
      "name": "Jobs.2023",
      "as": "2023 Jobs",
      "operation": {
        "geoparent": "0",
        "along": "Industry",
        "base": "Jobs.2010"
      }
    }
  ],
  "constraints": [
    {
      "dimensionName": "Industry",
      "map": {
        "Full Service Restaurants": [
          "722511"
        ]
      },
      "mapLevel": {
        "level": 3,
        "predicate": [
          16
        ]
      }
    }
  ],
  "sortBy": [
    {
      "name": "2023 Jobs",
      "direction": "ascending"
    }
  ],
  "offset": 100,
  "limit": 50
}

Response

OK

timingsstring[] required
totalRowsinteger required