Endpoint Examples

/totals

Get summary metrics on all profiles matching the filters.

`POST`/totals

Query Parameters

Name	Type	Description
`area_version`	enum	Specify US Area taxonomy version to use. This parameter is optional. Default: us_area_2024_4 Must be one of: `us_area_2024_3`, `us_area_2024_4`
`soc_version`	enum	Specify SOC taxonomy version to use. This parameter is optional. Default: `soc_2021` Must be one of: `soc_2021`
`title_version`	enum	Specify Job Title taxonomy version to use. This parameter is optional. Default: `emsi` Must be one of: `emsi`
`cip_version`	enum	Specify CIP taxonomy version to use. This parameter is optional. Default: `cip2010` Must be one of: `cip2010`, `cip2020`
`company_version`		Specify company taxonomy version to use. This parameter is optional. Default: `emsi_company` Must be one of: `emsi_company`
`onet_version`	enum	Specify ONET taxonomy version to use. This parameter is optional. Default: `onet_2019` Must be one of: `onet_2019`
`naics_version`	enum	Specify NAICS taxonomy version to use. This parameter is optional. Default: `naics_std_2022` Must be one of: `naics_std_2022`
`new_taxonomy_versions`	enum	Use new taxonomy versions. This parameter is optional. Must be one of: `true`, `false`
`area_us_version`	enum	Specify US Area taxonomy version to use. This parameter is optional. Default: `1.0.3` Must be one of: `1.0.2`, `1.0.3`
`soc_lightcast_version`	enum	Specify SOC Lightcast taxonomy version to use. This parameter is optional. Default: `2018.2021.0` Must be one of: `2018.2021.0`
`onet_standard_version`	enum	Specify ONET Standard taxonomy version to use. This parameter is optional. Default: `2019.0.0` Must be one of: `2019.0.0`
`lot_version`	enum	Specify LOT taxonomy version to use. This parameter is optional. Default: `7` Must be one of: `7`, `6`

Request Body

{
  "filter": {
    "last_updated": {
      "start": "2020"
    },
    "company_name": [
      "Intel"
    ],
    "skills_name": {
      "include": [
        "C++ (Programming Language)"
      ],
      "exclude": [
        "R (Programming Language)"
      ]
    }
  },
  "metrics": [
    "profiles",
    "unique_schools"
  ]
}

Code Examples

curl --request POST \
  --url https://api.lightcast.io/profiles/totals \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{ "filter": { "last_updated": { "start": "2020" }, "company_name": [ "Intel" ], "skills_name": { "include": [ "C++ (Programming Language)" ], "exclude": [ "R (Programming Language)" ] } }, "metrics": [ "profiles", "unique_schools" ] }'

Response Examples

{
  "data": {
    "totals": {
      "profiles": 8448,
      "unique_schools": 2117
    }
  }
}

{
  "errors": [
    {
      "status": 400,
      "title": "Malformed Request",
      "detail": "Expected array"
    }
  ]
}

{
  "errors": [
    {
      "status": 422,
      "title": "Invalid request content",
      "detail": "Invalid keyword search expression syntax:\n\t\"general merchandise\" OR \"apparel\" OR \"grocery\" OR\n\t                                                  ^"
    }
  ]
}