Skip to main content
GET
Indicator — Population table (US/JP/VN)

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

limit
integer
default:4

Number of most recent periods (columns) to return.

Required range: 1 <= x <= 20
Example:

4

Response

Population table.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object
required

A country × period table. rows[].values is positionally aligned with columns, so rows[0].values[2] is the value for columns[2].

meta
object

Response metadata. Always present; timestamp is the server time the response was generated.