Inspect Grapheme GET

Inspects a single grapheme.

Path Parameters

grapheme

string

required

Grapheme to inspect. Should be url-encoded (except when using the Swagger UI).

Response

200 - application/json

rating

enum<integer>

required

The rating of a name/label/grapheme based on multiple conducted checks.

• pass: All checks passed.
• warn: At least one check failed with a WARN status but no check failed with an ALERT status.
• alert: At least one check failed with an ALERT status.

Available options:

2,

3,

4

risk_count

integer

required

The number of checks that have a status of alert or warn.

highest_risk

object | null

required

The check considered to be the highest risk. If no check has a status of alert or warn, this field is null.

Show child attributes

normalization

enum<string>

required

The ENSIP-15 normalization status of a grapheme. This check does not consider the context of the grapheme and is not equivalent to ens_normalize(grapheme). A normalized grapheme can be combined with other normalized graphemes to form an unnormalized label. The position of a grapheme in a label can also affect the normalization status of the label.

• normalized: The grapheme is normalized.
• unnormalized: The grapheme is not normalized.

Available options:

normalized,

unnormalized

grapheme

string

required

The analyzed grapheme.

grapheme_name

string

required

The name of the grapheme.

grapheme_type

string

required

The type of the grapheme. If all characters in the grapheme have the same type, that type is returned. Otherwise, special is returned.

• simple_letter - [a-z]
• simple_number - [0-9]
• other_letter - a letter (single-char grapheme) in any script that is not simple; LC class http://www.unicode.org/reports/tr44/#GC_Values_Table
• other_number - a digit (single-char grapheme) in any script that is not simple; N class http://www.unicode.org/reports/tr44/#GC_Values_Table
• hyphen - a hyphen
• dollarsign - a dollar sign
• underscore - an underscore
• emoji - an emoji or emoji ZWJ sequence
• invisible - zero width joiner or non-joiner
• special - for any grapheme that doesn't match one of the other classifications or if characters have different types

grapheme_script

string

required

Script name of the grapheme computed from the script names of its characters.

grapheme_description

string

required

Description of the grapheme type.

checks

object[]

required

A list of checks that were performed on the grapheme.

Show child attributes

grapheme_link

string | null

required

Link to an external page with information about the grapheme.

• null for multi-character graphemes

confusables

object[]

required

A list graphemes that can be confused with the analyzed grapheme. The list does not contain the analyzed grapheme. A canonical form of the grapheme is the first element of the list, if it is known. Otherwise, the first element is a different confusable.

Show child attributes

canonical_grapheme

string | null

required

A grapheme that is the canonical form of the analyzed grapheme.

• null if the canonical form is not known
• does not imply that the canonical grapheme/label/name is normalized

title

string

required

A human-readable title based on the rating.

subtitle

string

required

A human-readable subtitle based on the rating.

grapheme_link_name

string

required

The name of the webpage that grapheme_link links to.

• "No link is available" if grapheme_link is null

codepoints

string[]

required

The codepoints of the grapheme in the format U+XXXX. Some graphemes may have multiple codepoints.