Crea attività di rendering della dashboard

Versione 4.0.23.6 (più recente)

Crea una nuova attività per visualizzare una dashboard in un documento o un'immagine.

Restituisce un oggetto attività di rendering. Per controllare lo stato di un'attività di rendering, passa il valore di rendering_task.id a Recupera l'attività di rendering. Una volta completata l'attività di rendering, puoi scaricare il documento o l'immagine risultante utilizzando l'opzione Recupera i risultati dell'attività di rendering.

Richiesta

POST /render_tasks/dashboards/{dashboard_id}/{result_format}
Tipo di dati
Descrizione
Richiesta
HTTPRequest
percorso
Percorso HTTP
Espandi definizione HTTPPath...
ID_dashboard
string
ID della dashboard da visualizzare. L'ID può essere anche una dashboard LookML.
formato_risultato
string
Tipo di output: pdf, png o jpg
body
HTTPBody
Espandi definizione HTTPBody...
body
Parametri delle attività di rendering della dashboard
Espandi definizione CreateDashboardRenderTask...
filtri_dashboard
string
Filtra i valori da applicare alle query della dashboard in formato di query URL
stile_dashboard
string
Stile layout dashboard: a colonna singola o a mosaico
della query
Query HTTP
Espandi definizione HTTPQuery in corso...
width
integer
Larghezza in uscita in pixel
height
integer
Altezza di output in pixel
campi
string
Campi richiesti:
pdf_whitepaper_size
string
Formato carta per pdf. Il valore può essere uno dei seguenti: ["lettera","legal","tabloid","a0","a1","a2","a3","a4","a5"]
pdf_orizzontale
boolean
Se visualizzare pdf con orientamento orizzontale in carta
tabelle_lunghe
boolean
Indica se espandere o meno la visualizzazione della tabella a lunghezza intera

Risposta

200: Attività di rendering

Tipo di dati
Descrizione
può
oggetto
Operazioni che l'utente corrente può eseguire su questo oggetto
creata_alle
string
L'attività di rendering Data/Ora è stata creata
filtri_dashboard
string
Filtra i valori da applicare alle query della dashboard in formato di query URL
ID_dashboard
string
ID della dashboard di cui eseguire il rendering
stile_dashboard
string
Stile layout dashboard: a colonna singola o a mosaico
final_at
string
L'attività di rendering di data/ora è stata completata
height
integer
Altezza di output in pixel. I layout a flusso potrebbero ignorare questo valore.
id
string
ID dell'attività di rendering
look_id
string
ID dell'aspetto da visualizzare
lookml_dashboard_id
string
ID della dashboard Lookml da visualizzare
id_query
string
ID della query da visualizzare
id_elemento_dashboard
string
ID dell'elemento della dashboard da visualizzare: l'elemento della dashboard UDD sarà numerico, mentre l'elemento della dashboard di LookML sarà model_name::dashboard_title::lookml_link_id
tempo_esecuzione_query
number
Numero di secondi trascorsi a eseguire query
rendering_runtime
number
Numero di secondi trascorsi per il rendering dei dati
formato_risultato
string
Formato di output: pdf, png o jpg
runtime
number
Secondi totali trascorsi per l'attività di rendering
stato
string
Stato attività di rendering: enqueued_for_query, querying, enqueued_for_render, rendering, operazione riuscita, errore
stato_dettaglio
string
Ulteriori informazioni sullo stato attuale
ID_utente
string
Le autorizzazioni dell'account utente in cui verrà eseguita l'attività di rendering.
width
integer
Larghezza in uscita in pixel

400: Richiesta errata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

404: Non trovata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

409: Risorsa già esistente

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

422: Errore di convalida

Tipo di dati
Descrizione
messaggio
string
Error details (Dettagli errore)
Espandi definizione ValidationErrorDetails...
campo
string
Campo con errore
codice
string
Codice di errore
messaggio
string
Messaggio informativo sull'errore
documentazione_url
string
Link alla documentazione
documentazione_url
string
Link alla documentazione

429: Troppe richieste

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

Esempi