GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
industry
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/industry \
  --header 'Authorization: Basic <encoded-value>'
{
  "label": "Fruit and Vegetable Preserving and Specialty Food Manufacturing",
  "probability": 0.42,
  "taxonomy": "naics",
  "taxonomy_value": "3114"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

end_user_id_or_heron_id
string
required

The end_user_id or heron_id of EndUser

Query Parameters

naics_code_max_digits
integer

Maximum number of digits in NAICS code

Required range: 2 <= x <= 6
Example:

6

naics_code_min_digits
integer

Minimum number of digits in NAICS code

Required range: 2 <= x <= 6
Example:

2

Response

200 - application/json
OK
label
string

The text name of the taxonomy value

Example:

"Fruit and Vegetable Preserving and Specialty Food Manufacturing"

probability
number

The probability that the end user is associated with the industry; we will always return the highest probability industry

Example:

0.42

taxonomy
string

Industry classification system used

Example:

"naics"

taxonomy_value
string

The predicted industry for the end user according to taxonomy

Example:

"3114"