Créer un filtre de tableau de bord

Version 4.0.23.6 (la plus récente)

Créez un filtre de tableau de bord avec un ID spécifique.

Demande

POST /dashboard_filter
Type de données
Description
Demande
HTTPRequest
body
Corps HTTP
Développer la définition HTTPBody...
body
Filtre du tableau de bord
Développer la définition de "CreateDashboardFilter"...
id
string
Identifiant unique
id_tableau_de_bord
string
ID du tableau de bord
name
string
Nom du filtre
title
string
Titre du filtre
type
string
Type de filtre : "Date", "Nombre", "Chaîne" ou "Champ"
default_value
string
Valeur par défaut du filtre
modèle
string
Modèle de filtre (obligatoire si type = champ)
exploration
string
Explorer le filtre (obligatoire si le champ correspond au type)
dimension
string
Dimension de filtre (obligatoire si type = champ)
champ
objet
Informations sur le champ
ligne
integer
Afficher l'ordre de ce filtre par rapport aux autres filtres
écoute_des_filtres
chaîne[]
autoriser_plusieurs_valeurs
booléen
Indique si le filtre autorise plusieurs valeurs de filtre (obsolètes dans la dernière version des tableaux de bord)
required
booléen
Indique si le filtre nécessite une valeur pour exécuter le tableau de bord
Configuration de l'interface utilisateur
objet
Configuration visuelle pour ce filtre. Permet de configurer la façon dont l'UI de ce filtre doit s'afficher.
query
Requête HTTP
Développer la définition de la requête HTTP...
champs
string
Champs demandés

Réponse

200: Filtre du tableau de bord

Type de données
Description
(objet)
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
string
Identifiant unique
id_tableau_de_bord
string
ID du tableau de bord
name
string
Nom du filtre
title
string
Titre du filtre
type
string
Type de filtre : "Date", "Nombre", "Chaîne" ou "Champ"
default_value
string
Valeur par défaut du filtre
modèle
string
Modèle de filtre (obligatoire si type = champ)
exploration
string
Explorer le filtre (obligatoire si le champ correspond au type)
dimension
string
Dimension de filtre (obligatoire si type = champ)
champ
objet
Informations sur le champ
ligne
integer
Afficher l'ordre de ce filtre par rapport aux autres filtres
écoute_des_filtres
chaîne[]
autoriser_plusieurs_valeurs
booléen
Indique si le filtre autorise plusieurs valeurs de filtre (obsolètes dans la dernière version des tableaux de bord)
required
booléen
Indique si le filtre nécessite une valeur pour exécuter le tableau de bord
Configuration de l'interface utilisateur
objet
Configuration visuelle pour ce filtre. Permet de configurer la façon dont l'UI de ce filtre doit s'afficher.

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

409: La ressource existe déjà

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

Examples