Skip to Content

CookiePolicy

Provides information about the cookie policy and user consents for the session.

Type Definition

type CookiePolicy { value: String consents: [String] }

Fields

FieldTypeNullableDescriptionRelated Types
valueStringYesCookie policy value for the session (e.g., null, required, all, custom).None
consents[String]YesUser’s consent choices for the cookie policy.String

Relationships

  • The consents field is a list of strings representing the user’s consent choices related to the cookie policy.
  • There are no direct relationships to other object types beyond scalar string arrays.

Usage Examples

Basic Query

{ cookiePolicy { value consents } }

Field Selection

{ cookiePolicy { value } }
{ cookiePolicy { consents } }

Nested Queries

The CookiePolicy type contains only scalar fields and does not have nested object fields.

Filtering and Sorting

Filtering or sorting is not applicable directly on the CookiePolicy object type as it represents session-specific data and does not support pagination or list queries.

Implements

This type does not implement any interfaces.

Connections

There are no connection fields or pagination support on the CookiePolicy type.

  • String — used for both the value and elements of the consents list.

Best Practices

  • Use the value field to quickly determine the overall cookie policy status for the session.
  • Use the consents array to understand specific user consent choices, which can help tailor user experience or comply with legal requirements.
  • Since both fields are optional, always check for null or empty values in your client code to avoid runtime errors.
  • Avoid assuming the presence of any particular consent string; handle the array dynamically.

Notes

  • The API currently requires no authentication, but this may change in future versions.
  • The CookiePolicy object is designed to provide session-level cookie consent information and should be treated as ephemeral data.
  • Because the fields are optional, clients should implement robust null checks.
  • There are no computed or derived fields in this type.
  • No field arguments are defined for this type.
  • Performance impact is minimal as this object is lightweight and typically returned as part of session or user context queries.
Last updated on