Evaluate meals and return the 2015-mHEI.

POST

/evaluate/healthy-eating-index

Evaluates a list of meals regarding 2015-mHEI.

Authorizations

• ApiKeyAuth

Request Body

List of meals to evaluate

Array<object>

object

entries

required

Array<object>

object

amount

number

Example

12345

food_id

required

string

Example

example_id

unit

required

string

Allowed values: µg mg g kg ml l

Example

g

weighted_before_process

Was it weighed before processing (raw)?

boolean

Responses

200

Evaluation results

object

components

Array<object>

object

component

string

Allowed values: total_fruits whole_fruits total_vegetables greens_and_beans whole_grains dairy total_protein_foods seafood_and_plant_proteins refined_grains added_sugars saturated_fats fatty_acids sodium

label

string

max_score

number

score

number

total_score

number

Headers

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Requests remaining in current window

X-RateLimit-Reset

integer

Unix timestamp when rate limit resets

X-RateLimit-Used

integer

Requests used in current window

400

Validation Error

object

error

object

code

string

details

message

string

401

Unauthorized

object

error

object

code

string

details

message

string

429

Rate limit exceeded

object

error

object

code

string

details

message

string

Headers

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Requests remaining in current window

X-RateLimit-Reset

integer

Unix timestamp when rate limit resets

X-RateLimit-Used

integer

Requests used in current window

X-Retry-After

integer

Seconds to wait before retrying

500

Internal Server Error

object

error

object

code

string

details

message

string