Versión 4.0.23.2
Enumerar todos los planes programados
Muestra todos los planes programados que pertenecen al emisor o a un usuario determinado.
Si no se proporciona un user_id, esta función muestra los planes programados que son propiedad del emisor.
Para enumerar todos los programas de todos los usuarios, pasa all_users=true
.
El emisor debe tener el permiso see_schedules
para ver los planes programados de otros usuarios.
Solicitud
GET
/scheduled_plans
Tipo de datos
Descripción
verá la consulta cuando se guarde
HTTPQuery
Expandir definición de HTTPQuery...
user_id
string
Muestre planes programados que pertenezcan a este user_id. Si no se proporciona, muestra planes programados que son propiedad del emisor.
campos
string
Lista de nombres de campos delimitados por comas. Si se proporciona, solo los campos especificados se incluirán en la respuesta.
todos_los_usuarios
booleano
Mostrar planes programados que pertenezcan a todos los usuarios (el emisor requiere el permiso see_schedules)
Respuesta
200: Plan programado
Tipo de datos
Descripción
del espacio
string
Nombre de este plan programado
user_id
string
ID del usuario propietario de este plan programado
carrera_como_destinatario
booleano
Si la programación se ejecuta como destinatario (solo se aplica a destinatarios de correo electrónico)
habilitada
booleano
Si SchedulingPlan está habilitado
look_id
string
ID de un estilo
id_panel
string
ID de un panel
look_dashboard_id
string
ID de un panel de LookML
string_filtros
string
String de consulta para ejecutar aspecto o panel con
filtros_panel
string
(OBSOLETO) Alias para el campo filters_string
requerir_resultados
booleano
La publicación debería ocurrir si se ejecuta el panel o el resultado muestra resultados
requerir_no_resultados
booleano
La publicación debería ocurrir si el panel no muestra resultados
requerir_cambio
booleano
La entrega debería ocurrir si los datos cambiaron desde la última ejecución
send_all_results
booleano
Ejecutará una consulta ilimitada y enviará todos los resultados.
crontab
string
Especificación de crontab de estilo Vixie para ejecutar
grupo de datos
string
Nombre de un grupo de datos; si se especifica, se ejecutará cuando se active el grupo de datos (no se puede usar con una string cron)
zona horaria
string
Zona horaria para interpretar la crontab especificada (la zona predeterminada es la zona horaria de la instancia de Looker)
ID de la consulta
string
ID de la consulta
Expandir la definición SchedulingPlanDestination...
ID_de_plan_programado
string
ID de un plan programado de tu propiedad
format
string
El formato de datos que se enviará al destino determinado. Los formatos admitidos varían según el destino, pero incluyen: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "executed_pdf", "wysiwyg_png"
Aplicando formato
booleano
¿Los valores tienen formato? (con símbolos de moneda, separadores de dígitos, etc.)
apply_vis
booleano
Indica si las opciones de visualización se aplican a los resultados.
de la página web.
string
Dirección del destinatario. Para correos electrónicos, p.ej., “usuario@example.com”. Para webhooks, p.ej., “https://examle.domain/path”. Para Amazon S3, p.ej., “s3://nombre-del-bucket/ruta/”. En el caso de SFTP, p.ej., "sftp://nombre-de-host/ruta/".
destinatario_de la búsqueda
lock
booleano
Si el destinatario es un usuario de Looker en la instancia actual (solo se aplica a destinatarios de correo electrónico)
tipo
string
Tipo de dirección ('email', 'webhook', 's3', or 'sftp')
Parámetros
string
Un objeto JSON que contiene parámetros para la programación externa. Para Amazon S3, esto requiere claves y valores para access_key_id y la región. Para el SFTP, esto requiere una clave y un valor para el nombre de usuario.
parámetros_secretos
string
Un objeto JSON que contiene parámetros secretos para la programación externa (solo escritura). Para Amazon S3, esto requiere una clave y un valor de secret_access_key. Para el SFTP, se requiere una clave y un valor para la contraseña.
mensaje,
string
Mensaje opcional que se incluirá en los correos electrónicos programados
ejecución_una vez
booleano
Si el plan en cuestión se debe ejecutar una sola vez (por lo general, para pruebas)
include_links
booleano
Si se deben incluir vínculos a Looker en este SchedulingPlan
base_url_personalizada
string
Dominio de URL personalizada para la entidad programada
parámetros_url_personalizados
string
Ruta de acceso y parámetros de URL personalizados para la entidad programada
etiqueta_URL_personalizada
string
Etiqueta de URL personalizada de la entidad programada
URL_personalizada_programa
booleano
Si se debe volver a mostrar el vínculo personalizado en lugar del vínculo estándar
pdf_paper_size
string
El tamaño del papel que debe tener el PDF debe ajustarse. Los valores válidos son: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4" y "a5".
pdf_horizontal
booleano
Si se debe formatear el PDF para la orientación horizontal
incorporar
booleano
Si este programa está en un contexto de incorporación o no
tema_color
string
Esquema de colores del panel, si corresponde
tablas_largas
booleano
Si se despliega la tabla completa o no
ancho_tabla_intercalada
integer
Ancho del píxel en el que renderizamos las visualizaciones de tablas intercaladas
creado_en
lock
string
Fecha y hora en que se creó el SchedulingPlan
actualizado_a
lock
string
Fecha y hora de la última actualización de SchedulingPlan
usuario
lock
Usuario propietario de este SchedulingPlan
Expandir la definición de UserPublic...
que pueden
lock
objeto
Operaciones que el usuario actual puede realizar en este objeto
first_name
lock
string
Nombre
last_name
lock
string
Apellido
display_name
lock
string
Nombre completo para mostrar (disponible solo si se configuran el nombre y el apellido)
avatar_url
lock
string
URL de la imagen de avatar (puede ser genérica)
url
lock
string
Vínculo para obtener este elemento
siguiente_ejecución
lock
string
Cuándo se ejecutará el SchedulingPlan (nulo si se ejecuta una vez)
última_ejecución_en
lock
string
Cuándo se ejecutó por última vez el SchedulingPlan
que pueden
lock
objeto
Operaciones que el usuario actual puede realizar en este objeto
400: Bad Request
Tipo de datos
Descripción
mensaje,
lock
string
Detalles del error
url_documentación
lock
string
Vínculo a la documentación
404: No encontrado
Tipo de datos
Descripción
mensaje,
lock
string
Detalles del error
url_documentación
lock
string
Vínculo a la documentación
422: Error de validación
Tipo de datos
Descripción
mensaje,
lock
string
Detalles del error
Expandir la definición de ValidationErrorDetail...
campo
lock
string
Campo con error
código
lock
string
Código de error
mensaje,
lock
string
Mensaje de información de error
url_documentación
lock
string
Vínculo a la documentación
url_documentación
lock
string
Vínculo a la documentación
Ejemplos