Dashboard

Configures an analytics dashboard.

$idstring Required

The unique identifier for the dashboard resource.

Must be at least 1 characters long

Must be at most 97 characters long

$schemaconst Required

Specific value: "https://schema.yext.com/config/analytics/dashboard/v1"

namestring Required

The human-readable name of the dashboard.

Must be at least 1 characters long

Must be at most 25 characters long

insightsarray of object Required

Each item of this array must be:

Type: object

Includes an insight on the dashboard.

string Required

An insight resource identifier for the insight to include in the dashboard.

string

A caption to give the insight on the dashboard.

Must be at least 1 characters long

Must be at most 500 characters long

integer Required

The x-position of the top-left corner of the insight on the dashboard, in grid units.

Value must be greater or equal to 0 and lesser or equal to 4

integer Required

The y-position of the top-left corner of the insight on the dashboard, in grid units.

Value must be greater or equal to 0 and lesser or equal to 100

integer Required

The width of the insight on the dashboard, in grid units.

Value must be greater or equal to 2 and lesser or equal to 6

integer Required

The height of the insight on the dashboard, in grid units.

Value must be greater or equal to 1 and lesser or equal to 5

string

The icon to use for the insight on the dashboard.

Must be at least 1 characters long

Must be at most 100 characters long

filtersarray of object

An array of filtering clauses which override insight filters. Each clause object must contain the filter property and a single operator property.

Must contain a minimum of 1 items

Must contain a maximum of 5 items

Each item of this array must be:

Type: object

enum (of string) Required

The filter resource identifier, which must be a filter override supported by dashboards.

Must be one of:

  • “yext/date”
  • “yext/entity”
  • “yext/entityFolder”
  • “yext/entityLabel”
  • “yext/entityType”

array of string

For the yext/date filter, this is the start and end dates in YYYY-MM-DD format.

Must contain a minimum of 2 items

Must contain a maximum of 2 items

Each item of this array must be:

Type: string

enum (of string)

For the yext/date filter, the name of a preset date range.

Must be one of:

  • “DAYS_7”
  • “DAYS_30”
  • “DAYS_90”
  • “WEEKS_12”
  • “MONTHS_1”
  • “MONTHS_13”
  • “QUARTERS_1”

array of string

An array of entity resource identifiers for the yext/entity filter.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of entity-folder resource identifiers for the yext/entityFolder filter.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of entity-label resource identifiers for the yext/entityLabel filter.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string

array of string

An array of entity-type resource identifiers for the yext/entityType filter.

Must contain a minimum of 1 items

Each item of this array must be:

Type: string