Lexile API Calls

Overview

This API requires authentication! Please supply your credentials (email address and authentication token) alongside every API request using HTTP Basic Authentication. Your authentication token is provided by MetaMetrics in your onboarding welcome letter.

Base URL

https://sheetlabs.com/SRA/LexileCareerData

Query Parameters

The following parameters may be passed to the API to filter the results returned. Parameters marked as 'required' must be provided. Passing multiple parameters is supported, and only records matching all of the given parameters will be returned.


Parameter	Type	Required	Description
`SOCCode`	String	No	Standard Occupational Classification from the US Bureau of Labor Statistics
`CareerName`	String	No (allows partial)	Career Name from the US Bureau of Labor Statistics
`Cluster`	Integer	No	One of 16 career clusters identified by US Bureau of Labor Statistics
`Education`	String	No	The minimum level of education typical of career
`BrightOutlookCareer`	Boolean	No	Occupations which are expected to grow rapidly in the next several years according to O*Net
`LexileMedianMeasure`	String	No	Median Lexile measure of ability associated with a career
`LexileLowerQuartile`	String	No	Lower Quartile Lexile Measure of ability associated with a career
`LexileUpperQuartile`	String	No	Upper Quartile Lexile Measure of ability associated with a career

Response

The response will be an array of records, each of which will have the fields in the table below. Fields may be empty. We support the following data types in our various Simple REST APIs:

string A UTF-8 string, supporting the full unicode character set. API clients may search on partial inputs.
integer A signed 64-bit integer.
double A signed floating point number of up to 65 digits in length (including integer and fractional parts).
boolean A simple true/false boolean value. May also be expressed as 1 (true) or 0 (false).
datetime An ISO 8601 formatted date with accompanying time component. All dates are internally stored in UTC.


Field	Type	Description
`SOCCode`	String	-
`CareerName`	String	-
`Cluster`	Integer	-
`Education`	String	-
`BrightOutlookCareer`	Boolean	-
`LexileMedianMeasure`	String	-
`LexileLowerQuartile`	String	-
`LexileUpperQuartile`	String	-

Code Examples

Sample code for interacting with the API is provided below. JSON output is the default, but you may also choose XML by suffixing the endpoint with .xml.

cURL example

$ curl -u
"user@emailaddress.com:321bbcc9-d123-42e2-8675-1111aaaa2222"
"https://sheetlabs.com/SRA/LexileCareerData"
[ {
"SOCCode" : "string",
"CareerName" : "string",
"Cluster" : "1234",
"Education" : "string",
"BrightOutlookCareer" : "true",
"LexileMedianMeasure" : "string",
"LexileLowerQuartile" : "string",
"LexileUpperQuartile" : "string",
} ]

Javascript example

let username = "user@emailaddress.com"
let token = "da6dfdb8-e235-4982-a1a5-3ed567f00d9b"
fetch("https://sheetlabs.com/SRA/LexileCareerData" , {
    method: 'GET',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Basic ' + base64.encode(username + ":" + token)
},
})
.then(response => {
    if (response.status === 200) {
        return response.json();
    } else {
        throw new Error('Something went wrong');
    }
})
.then(data => console.log(data))
.catch((error) => {
    console.error(error);
});