Insights

Read one Workforce screen

One Workforce screen, read as the industry audience, with the filters a member’s screen takes: at most three, a state only with its country, each a recorded value; an unknown filter, a repeated one or a value outside the vocabulary is 400 invalid_request. See the Insights tag for the floors. A publication that has never run answers only schema_version, screen, generated_at and cohort, with status not_ready. A screen MyPilotIndex has switched off is 400 invalid_request, as it is for a member. The token must carry insights.read, otherwise 403 scope_missing. A name outside the six screens is 404 not_found.

GET

partner

insights

workforce

{screen}

Read one Workforce screen

curl --request GET \
  --url https://{devApiHost}/v1/partner/insights/workforce/{screen} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{devApiHost}/v1/partner/insights/workforce/{screen}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/insights/workforce/{screen}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "schema_version": 1,
  "screen": "overview",
  "generated_at": "2026-11-07T12:00:00Z",
  "as_of": "2026-11-07",
  "access": "industry",
  "filters": {
    "requested": {
      "country": "BR"
    },
    "applied": {
      "country": "BR"
    },
    "broadened": []
  },
  "cohort": {
    "status": "ok",
    "n_band": "250_499",
    "coverage": {
      "hours": 0.9,
      "licenses": 0.85,
      "type_ratings": 0.4,
      "score": 0.95,
      "dob": 0.8
    }
  },
  "privacy": {
    "cell_floor": 5,
    "cohort_floor": 20
  },
  "sections": {}
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Path Parameters

screen

enum<string>

required

Available options:

overview,

geography,

qualifications,

aircraft,

score,

intent

Query Parameters

country

string

An ISO 3166 alpha-2 country on record.

state

string

A state on record in the country, which the read must also name.

sector

string

The sector of the pilot's current position, such as major_airline, cargo or corporate.

role

string

The pilot's role, such as captain, first_officer or instructor.

hours_band

string

A band of total hours, such as 0_500 or 3001_5000.

license

string

The pilot's highest license, such as atp or cpl.

authority

string

A licensing authority on record.

aircraft_category

string

An aircraft category on record.

type_rating

string

A type rating on record.

score_band

string

A band of the MPI Score.

career_target

string

The career the pilot is aiming at.

Response

The screen.

One screen. The members past cohort are absent when the publication has never run. sections differs per screen: its blocks carry shares and bands, never a count of pilots, and a block that cannot clear its floor says so.

schema_version

integer

required

screen

enum<string>

required

Available options:

overview,

geography,

qualifications,

aircraft,

score,

intent

generated_at

string<date-time>

required

cohort

object

required

Show child attributes

as_of

string<date> | null

The newest recorded fact of the cohort.

access

enum<string>

The audience the answer was read for.

Available options:

industry

filters

object

Show child attributes

privacy

object

The floors the answer was measured against.

Show child attributes

sections

object

⌘I

Read one Workforce screen

curl --request GET \
  --url https://{devApiHost}/v1/partner/insights/workforce/{screen} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{devApiHost}/v1/partner/insights/workforce/{screen}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/insights/workforce/{screen}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "schema_version": 1,
  "screen": "overview",
  "generated_at": "2026-11-07T12:00:00Z",
  "as_of": "2026-11-07",
  "access": "industry",
  "filters": {
    "requested": {
      "country": "BR"
    },
    "applied": {
      "country": "BR"
    },
    "broadened": []
  },
  "cohort": {
    "status": "ok",
    "n_band": "250_499",
    "coverage": {
      "hours": 0.9,
      "licenses": 0.85,
      "type_ratings": 0.4,
      "score": 0.95,
      "dob": 0.8
    }
  },
  "privacy": {
    "cell_floor": 5,
    "cohort_floor": 20
  },
  "sections": {}
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "rate_limited"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Overview

Grants

Jobs

Publishing

Insights

Certificates

Webhooks

Read one Workforce screen

Authorizations

Path Parameters

Query Parameters

Response