API Databank – Key Response Dictionaries

Modified on: Thu, 1 Sep 2022 9:18 AM

Note that for the purpose of describing these dictionaries, the ( and ) characters indicate a choice and should be omitted in practice. For example, format: (“csv”, “excel”) indicates a choice between the strings csv and excel, so in practice this might look like format: “csv” or format: “excel”.

In contrast, the [ and ] characters indicate an array and must not be omitted.

Download

[ 
 {
  DatabankCode: string,
  ProducTypeCode: string,
  LocationCode: string,
  VariableCode: string,
  MeasureCode: see measure codes,
  AnnualData:
  {
    YYYY: float,
    YYYY: float,
    YYYY: float,
    …
  },
  QuarterlyData:
  {
    YYYYQQ: float,
    YYYYQQ: float,
    YYYYQQ: float,
    …
  }
 }
]

Selection

This is the same as the selection dictionary in the request body. However, the response version always includes fields that are otherwise optional in the request. These include: LastUpdate, ContactId, ShareCodeId, and IsDataFeed.

User

{
  ContactId: string,
  CompanyId: string,
  UserName: string,
  ApiKey: string,
  Email: string,
  Title: string,
  LastName: string,
  FirstName: string,
  CompanyName: string,
  IsTrialist: string,
  IsLockedOut: string,
  Roles: [string],
  SavedSelections:
  [ {
   Id: string,
   Name: string,
   Url: string
  } ]
 }

Measure codes

Several of these request and response objects have a MeasureCode field. This value describes how the annual data is represented. The available options are:

L – Level values
PY – Percentage difference year over year
DY – Difference year over year
P – Percentage difference quarter over quarter
D – Difference quarter over quarter
GR – Annualised growth rate