descrição (para análises detalhadas)

Esta página se refere ao parâmetro description, que faz parte de uma análise.

description também pode ser usado como parte de um campo, descrito na página de documentação do parâmetro description (para campos).

description também pode ser usado como parte de um painel, descrito na página de documentação dos parâmetros do painel.

Uso

explore: explore_name {
  description: "Description I Want"
}

Hierarquia Arquivo de modelo explore description

Valor padrão Nenhum Aceita Uma string

Definição

description permite adicionar informações sobre a análise à UI, para que os usuários possam receber mais informações ao criar consultas de análise. Por exemplo, aqui está um parâmetro description:

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

Se uma description for adicionada a uma análise, os usuários poderão ver a descrição passando o cursor sobre o ícone de informações ao lado do nome da análise na parte de cima do seletor de campos.

Os usuários também podem conferir uma descrição passando o cursor sobre o mesmo ícone de informações na lista suspensa de análises.

Se você não adicionar explicitamente um description a uma análise Explore, nenhuma descrição será mostrada.

Exemplos

Adicione uma descrição a uma análise chamada User:

explore: user {
  description: "All customer users, staff users are excluded"
}