Acessar todos os planos programados

Versão 4.0.23.6 (mais recente)

Listar todos os planos programados

Retorna todos os planos programados que pertencem ao autor da chamada ou ao usuário especificado.

Se nenhum user_id for fornecido, essa função retornará os planos programados que pertencem ao autor da chamada.

Para listar todas as programações de todos os usuários, transmita all_users=true.

O autor da chamada precisa ter a permissão see_schedules para ver os planos programados de outros usuários.

Solicitação

GET /scheduled_plans

Tipo de dados

Descrição

Solicitação

HTTPRequest

consulta

Consulta HTTP

Expandir a definição de HTTPQuery...

user_id

string

Retorna planos programados pertencentes a esse user_id. Se não for informado, retorna planos programados do autor da chamada.

campos

string

Lista de nomes de campos delimitada por vírgulas. Se fornecido, somente os campos especificados serão incluídos na resposta

todos_usuários

booleano

Retornar planos programados pertencentes a todos os usuários (o autor da chamada precisa da permissão see_schedules)

Resposta

200: Plano programado

Tipo de dados

Descrição

(matriz)

ScheduledPlan[]

nome

string

Nome do plano programado

user_id

string

ID do usuário proprietário do plano programado

executar_como_destinatário

booleano

Se a programação é executada como destinatário (aplicável somente a destinatários de e-mail)

ativado

booleano

Se o ScheduledPlan está ativado

look_id

string

ID de uma aparência

ID do painel

string

ID de um painel

lookml_dashboard_id

string

ID de um painel do LookML

string_de_filtros

string

String de consulta para executar a aparência ou o painel

painéis_filtros

string

(OBSOLETO) Alias para o campo filters_string

requer_resultados

booleano

A exibição deve ocorrer se a execução do painel ou a aparência retornar resultados

requer_não_resultados

booleano

A exibição deve ocorrer se a aparência do painel não retornar resultados

alterar_exigir

booleano

A entrega deve ocorrer se os dados tiverem mudado desde a última execução

enviar_todos_resultados

booleano

Executa uma consulta ilimitada e envia todos os resultados.

Crontab

string

Especificação do crontab no estilo Vixie quando executar

datagroup

string

Nome de um grupo de dados. Se especificado, será executado quando o grupo de dados for acionado (não pode ser usado com uma string cron)

timezone

string

Fuso horário para interpretar o crontab especificado (o padrão é o fuso horário da instância do Looker)

ID da consulta

string

ID da consulta

destination_plan_destination

ScheduledPlanDestination[]

Expandir definição ScheduledPlanDestination...

string

ID exclusivo

ID do plano programado

string

ID de um dos seus planos programados

formato

string

O formato de dados a ser enviado para o destino especificado. Os formatos compatíveis variam de acordo com o destino, mas incluem: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf" e "wysiwyg_png".

aplicar_formatação

booleano

Os valores são formatados? (contendo símbolos de moeda, separadores de dígitos etc.

apply_vis

booleano

Indica se as opções de visualização são aplicadas aos resultados.

address

string

Endereço do destinatário. Para e-mail, por exemplo, "usuario@example.com". Para webhooks, por exemplo, "https://examle.domain/path". Para o Amazon S3, por exemplo, "s3://bucket-name/path/". Para SFTP, por exemplo, "sftp://host-name/path/".

looker_recipient

booleano

Se o destinatário é um usuário do Looker na instância atual (aplicável somente a destinatários de e-mail)

tipo

string

Tipo de endereço ("e-mail", "webhook", "s3" ou "sftp")

parâmetros

string

Objeto JSON que contém parâmetros para programação externa. Para o Amazon S3, isso requer chaves e valores para access_key_id e região. Para SFTP, isso exige uma chave e um valor de nome de usuário.

parâmetros_secretos

string

Objeto JSON (somente gravação) contendo parâmetros secretos para programação externa. Para o Amazon S3, isso requer uma chave e um valor para secret_access_key. Para SFTP, isso exige uma chave e um valor para a senha.

mensagem

string

Mensagem opcional a ser incluída nos e-mails programados

run_once

booleano

Se o plano em questão precisa ser executado apenas uma vez (geralmente para testes).

links_incluir

booleano

Se links para o Looker devem ser incluídos neste ScheduledPlan

base_url_personalizada

string

Domínio de URL personalizado para a entidade programada

custom_url_params

string

Caminho de URL personalizado e parâmetros para a entidade programada

custom_url_label [rótulo_de_url_personalizado]

string

Rótulo de URL personalizado para a entidade programada

mostrar_URL_personalizado

booleano

Se o link personalizado será mostrado em vez do link padrão

pdf_paper_size

string

O tamanho do papel no qual o PDF deve ser formatado para caber. Os valores válidos são: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5".

pdf_paisagem

booleano

Se o PDF deve ser formatado para a orientação paisagem

incorporar

booleano

Se esta programação está em um contexto de incorporação ou não

tema_de_cor

string

Esquema de cores do painel, se aplicável

long_tables

booleano

Se a visualização da tabela deve ou não ser expandida

largura_da_tabela_in-line

integer

A largura do pixel em que renderizamos as visualizações da tabela inline

string

ID exclusivo

criado_em

string

Data e hora em que o ScheduledPlan foi criado

atualizado em

string

Data e hora em que o ScheduledPlan foi atualizado pela última vez

title

string

Título

user

UserPublic (em inglês)

Usuário que é o proprietário deste ScheduledPlan

Expandir definição UserPublic...

pode

objeto

Operações que o usuário atual pode realizar neste objeto

string

ID exclusivo

first_name

string

Nome

last_name

string

Sobrenome

display_name

string

Nome completo para exibição (disponível apenas se first_name e last_name estiverem definidos)

URL_do_ avatar

string

URL da imagem de avatar (pode ser genérico)

url

string

Link para obter este item

next_run_at

string

Quando o ScheduledPlan será executado novamente (nulo se for executado uma vez)

last_run_at

string

Quando o ScheduledPlan foi executado pela última vez

pode

objeto

Operações que o usuário atual pode realizar neste objeto

400: Solicitação inválida

Tipo de dados

Descrição

(objeto)

Erro

mensagem

string

Detalhes do erro

url_da_documentação

string

Link da documentação

404: não encontrado

Tipo de dados

Descrição

(objeto)

Erro

mensagem

string

Detalhes do erro

url_da_documentação

string

Link da documentação

422: erro de validação

Tipo de dados

Descrição

(objeto)

ValidationError.

mensagem

string

Detalhes do erro

erros

ValidationErrorDetail[]

Expandir a definição de ValidationErrorDetail...

campo

string

Campo com erro

código

string

Código do erro

mensagem

string

Mensagem de erro

url_da_documentação

string

Link da documentação

url_da_documentação

string

Link da documentação

Examples

Acessar todos os planos programados

Listar todos os planos programados

Solicitação

Resposta

200: Plano programado

400: Solicitação inválida

404: não encontrado

422: erro de validação

Examples

Python

TypeScript

Kotlin

Swift