Hygraph
Docs

#Glossary

#Basic concepts

ConceptDescription
API PlaygroundThe API Playground, located on the left sidebar of the Hygraph app, allows you to experiment with querying and mutating data.
AssetsThe Asset model is included in every project by default. It is commonly used for images, but can also support any file type. Assets can be fetched, referenced, transformed, uploaded, updated, published, localized, deleted, and embedded.
ComponentA component is a predefined set of fields that can be reused across models and content entries. You can think of a component as a flexible, reusable template where you define the fields once, and then fill them with different content every time you use it in a content entry.
Content modelingThe content model defines the schema of your content. It describes what kind of content you want to store, how it relates to other content, and how it can be edited within Hygraph.
Content viewsHygraph features default and custom content views. Default content views list all content entries created based on the respective models. Custom content views are filtered for specific content entries.
EnumerationAn enumeration (or enum for short) can be used to group values within a type. Enums are useful for filtering and defining certain content entries in your project.
ModelModels define the structure of your content. You build your schema by creating models and adding fields to them. Learn more in the quickstart guide.
MutationsOperations that allow you to insert new data or modify existing data on the server side. See mutations for the full reference.
Preview URLsPreview URLs are automatically generated links that allow you to preview content in your frontend before it is published. Configuring this feature adds a button to the content editor's right sidebar so editors can quickly access content previews.
RelationsReferences, often referred to as relations, allow you to connect one or more models together, and even reference multiple models as a single field type using GraphQL Union Types.
Remote sourcesRemote sources are Hygraph's content federation feature. They allow you to add content from other systems and sources to the Hygraph API without migrating the content itself.
Schema editorThe schema editor is where you add fields, create relationships between models, and define the structure of your content. See the Studio walkthrough to learn more.
System fieldsAll default and custom models come with managed system fields. These fields reflect certain states of your content, such as when it was last updated or published.
TaxonomyA taxonomy is a group of terms arranged in a hierarchical structure. Taxonomies are used to classify and logically connect content across multiple models. They are defined in the schema editor and support up to six levels of depth. Taxonomies are an enterprise feature.

#Content stages

This list offers a brief description of the two content stages every Hygraph project has by default.

Stage nameDescription
DraftThe working stage for content. Unpublished entries exist only here. Published entries also have a DRAFT copy for edits before re-publishing. Saving without publishing does not affect the live published version.
PublishedPublished content. If the published button displays green, the content has been pushed live. If it displays blue, a new draft version has been saved and the published content is now outdated.

You can also create custom content stages for your project. See content stages to find out more.

#Fields

Field typeDescription
Single line textString type field widget. Used for adding headings and titles.
Multi line textString type field widget. Used for adding longer text such as descriptions.
MarkdownString type field widget. A markdown editor.
SlugString type field widget. Used for adding URL-friendly identifiers to your content.
Rich textText type field widget. A text editor with formatting.
NumberInteger type field widget. Used for adding numeric fields such as IDs or identifiers.
FloatFloat type field widget. Used for numbers that include decimal values, such as ratings or prices.
BooleanBoolean type field widget. A toggle that represents true/false.
DateDate type field widget. A calendar date picker.
Date and timeDate and time type field widget. A calendar date picker that includes time.
JSON editorJSON type field widget. Allows adding arbitrary JSON structures.
Cloudinary assetJSON type field widget. Allows picking assets from Cloudinary.
Asset pickerAsset type field widget. Allows selecting assets from your project and supports any file type.
ColorColor type field widget. Supports HEX and RGBA.
MapLocation type field widget. Allows adding geo coordinates to your content.
DropdownEnumeration type field widget. Allows adding a dropdown list of values to your content.
Basic componentComponent type field widget. Used for a single fixed component type and can be configured for one or multiple instances. See components to learn more.
Modular componentModular component type field widget. Used for multiple component types. See components to learn more.
ReferenceRelation type field widget. Used for content relationships.
RESTREST type field widget. Used to add external data via REST.
GraphQLGraphQL type field widget. Used to add external data via GraphQL.
Widget nameDescription
Entry informationSystem sidebar widget, added to your model by default. Offers basic entry information.
LocalizationsSystem sidebar widget, added to your model by default. Allows viewing localized fields.
PreviewSystem sidebar widget. Allows previewing content changes by adding a preview link to your content.
ReleasesSystem sidebar widget. Allows grouping entries into content releases for coordinated publishing. Scheduled publishing is configured via publish actions and is an Enterprise feature.
StagesSystem sidebar widget, added to your model by default. Allows viewing in-app content stages.
VersionsSystem sidebar widget, added to your model by default. Allows viewing the version history of your content.

See system fields to learn more.

#Components

ConceptDescription
ComponentA component is a predefined set of fields that can be reused across models and content entries.
Component fieldA special field type in your Hygraph schema that defines which components of which type can be used in a model. Component fields can be of basic or modular types.
Component instanceA specific occurrence of a component type, containing content, inside a content entry.
Nested componentsFunctionality that allows you to create components within a component.

See components to learn more.

#Variants

ConceptDescription
Base entryThe main content entry that variants are built from. Updating a variant-enabled field in the base entry does not update the same field in its variants, and vice versa.
SegmentA named reference used to target a group of users based on shared characteristics or behaviors. Segments are managed externally and referenced in Hygraph to determine which variant of a content entry is delivered to a given audience.
VariantA personalized version of a content entry tailored to a specific audience segment. Variants inherit the structure of the main entry but allow certain fields to be customized independently, enabling content teams to deliver targeted experiences without duplicating entries. Variants are an enterprise feature.

See variants to learn more.