Glossary

This glossary documents all the essential terms used in the API documentation

A

API Token

An API token is a unique identifier of an application requesting access to your service. Your service would generate an API token for the application to use when requesting your service. You can then match the token they provide to the one you store in order to authenticate.

B

Barcode

A barcode, consisting of bars and spaces, is a machine-readable representation of numerals and characters.

Bearer Token

Bearer Tokens are the predominant type of access token used with OAuth 2.0. A Bearer Token is an opaque string, not intended to have any meaning to clients using it. Some servers will issue tokens that are a short string of hexadecimal characters, while others may use structured tokens such as JSON Web Token.

BMR

Basal metabolic rate. This is used to determine how much energy your body uses at rest, based on age, sex, height, and weight.

Branded Foods

Branded foods are known as all the foods that belong to a brand and include a trademark and a barcode. For example "Oreo", "Hershey", "Mazola", "McCormick", etc. Find the list of brand foods on this page.

BMI

Body Mass Index (BMI) is a person’s weight in kilograms (or pounds) divided by the square of height in meters (or feet). A high BMI can indicate high body fatness. BMI screens for weight categories that may lead to health problems, but it does not diagnose the body fatness or health of an individual.

$$BMI: weight (kg) / [height (m)]2$$

C

CD

Caloric Deficit. A calorie deficit occurs when the number of calories a person consumes in a day is smaller than the number of calories they burn.

Common Foods

Common foods are known as the most intaken foods on a daily basis. Among these common foods, we can find apples, cookies, milk, rice, sugar, noodles, etc.

Cursor

A cursor marks a position within a paginated set. When you use the Paginate function, and the total number of results exceeds the current page size, and after cursor marks the position for the next page of results, and a before cursor marks the end of the previous page of results. You use the after or before the cursor in subsequent queries to request additional results.

G

GraphQL

GraphQL is an open-source data query and manipulation language that provides declarative schema definitions and composable query syntax. For more information, see https://graphql.org/.

GraphQL Playground

GraphQL Playground is a graphical, interactive, in-browser GraphQL IDE, used to run queries and mutations.

GTIN

Global Trade Item Number (GTIN) can be used by a company to uniquely identify all of its trade items. GS1 defines trade items as products or services that are priced, ordered, or invoiced at any point in the supply chain.

J

JSON

JSON (JavaScript Object Notation) is a lightweight data-interchange format. A human-readable, plain-text format for expressing structured data. For more information, see http://www.json.org/.

JWT

A JSON Web Token, or JWT, is a digitally-signed object that is typically used to communicate verified and trusted information about a user, to essentially indicate that a specific user has been authenticated. For more information, see https://jwt.io/introduction/.

M

Magic Link

Magic links provide a way for users to authenticate without a password. The whole process of authentication with a magic link involves the user providing their email, then clicking said “magical link” to log in.

Mutation

A mutation refers to a query that changes data when using GraphQL.

N

NDB Number

This number is a unique identifier for each food in a specific form used for Foundation Foods and SR Legacy.

Node

A node is a computer (or virtual machine) with a unique network address that is running the Fauna database software.

Node Package Manager

npm (originally short for Node Package Manager) is a package manager for the JavaScript programming language maintained by npm, Inc. npm is the default package manager for the JavaScript runtime environment Node. js.

P

Pagination

Querying a list of data in discrete parts. See Search documentation

Q

Query

A query in GraphQL is used to fetch data.

TDEE

Total Daily Energy Expenditure indicates how many calories you burn in a day. Then, the BMR is multiplied by an activity factor to increase calories based on your activity level.

U

UPC

Universal Product Code (UPC) is a barcode symbology that is widely used worldwide for tracking trade items in stores. It consists of 12 numeric digits that are uniquely assigned to each trade item