Skip to main content

pageEditorGetBrandGuidelines

Returns an editor's brand guideline settings for one site as a JSON-encoded object with checks, voices, voiceTestContent, and profile. Built-in checks and voices replace saved entries with the same id and are added when missing, so a site with nothing saved still returns Crazy Egg defaults. Use pageEditorSaveBrandGuidelines to replace the settings. Requires a page editor token for the editor, or a logged-in user who owns the editor or can edit the site.

Page editor

This operation serves the Crazy Egg page editor. Besides personal access tokens, it accepts the page editor's own credential, and it checks access to the editor, page or site involved.

pageEditorGetBrandGuidelines(
  editorId: String!
  site: String!
): String

Arguments​

pageEditorGetBrandGuidelines.editorId ● String! non-null scalar​

Editor UUID from pageEditorCreatePage or pageEditorLatest.

pageEditorGetBrandGuidelines.site ● String! non-null scalar​

Site hostname such as www.example.com; settings are stored per registrable domain (example.com).

Type​

String scalar​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.