Filtrage des résultats de 10 DLC

Tous les 10 DLC GET Points d'extrémité de l'API vous permettent d'affiner vos résultats à l'aide de filtres.

Par exemple, au lieu d'obtenir la liste de toutes les marques, vous pourriez être intéressé par les marques de la catégorie REAL_ESTATE verticale. Dans ce cas, vous pouvez appliquer un filtre pour obtenir les informations suivantes REAL_ESTATE marques apparentées uniquement.

Structure de la demande

Les filtres sont transmis au point d'accès en tant que paramètres de requête. Dans votre requête, vous utiliserez le mot-clé filter comme clé, suivie de la requête sous la forme d'un objet JSON.

En voici un exemple :

Objet du filtre

Un objet filtre est un objet JSON contenant une requête de filtrage. Un objet filtre contient trois paires clé/valeur :

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      }
   ]
]

Champ d'applicationest le nom du champ dont vous souhaitez filtrer la valeur.

Type: c'est la condition de correspondance que vous souhaitez appliquer dans le filtre de recherche. Visitez le site conditions de filtrage pour voir les conditions disponibles.

Valeurest la valeur par laquelle vous souhaitez filtrer.

Conditions de filtrage

• regexp: Regex - Renvoie les enregistrements qui correspondent à la valeur du filtre basée sur l'expression régulière fournie.
• ==: Equal To - Renvoie les enregistrements qui correspondent exactement à la valeur du filtre.
• = : Pli égal - Recherche les enregistrements sans tenir compte de la casse (ceci s'applique aux caractères UTF-8).
• ^=: Commence par - Recherche les enregistrements commençant par la valeur du filtre.
• =$: Se termine par - Recherche les enregistrements se terminant par la valeur du filtre.
• ~=: Contient - Correspond aux enregistrements contenant la valeur du filtre.
• <: Moins de - correspond aux enregistrements inférieurs à la valeur du filtre.
• <=: Inférieur ou égal à - correspond aux enregistrements inférieurs ou égaux à la valeur du filtre.
• >: Plus que - correspond aux enregistrements supérieurs à la valeur de filtrage spécifiée.
• >=: Supérieur ou égal à - correspond aux enregistrements supérieurs ou égaux à la valeur du filtre.

Règles de filtrage

Vous pouvez avoir un maximum de trois filtrer les objets dans une requête. Cela signifie que vous pouvez trouver des résultats qui correspondent à un maximum de trois champs. Les objets filtres peuvent également être associés de différentes manières.

Par exemple, vous pouvez extraire les résultats correspondant à un objet filtre OU un autre. De même, les résultats qui correspondent à un objet filtrant ET autre.

Prenons le cas où nous souhaitons rechercher des marques pour lesquelles la valeur vertical est soit REAL_ESTATE OU ONG ET où l'identifiant du revendeur (reseller_id) est 12345.

Nous pouvons exprimer cela sous la forme d'une déclaration logique : ( (vertical == REAL_ESTATE OR vertical == NGO) AND (reseller_id == 12345) )

Filtrer les requêtes impliquant OU sont représentées à l'aide de crochets []. Par exemple, l'expression suivante(vertical == REAL_ESTATE OR vertical == NGO) devient [ [{filter object 1}, {filter object 2}] ].

Le crochet intérieur indique que vous souhaitez obtenir les résultats correspondant à l'une ou l'autre des options suivantes objet filtrant 1 OU objet filtrant 2.

Exemples de règles de filtrage

1. Correspondance objet filtrant 1; [ [{filter object 1}] ].
2. Correspondance objet filtrant 1 ET objet filtrant 2; [ [{filter object 1}], [{filter object 2}] ]
3. Correspondance objet filtrant 1 OU objet filtrant 2; [ [{filter object 1},{filter object 2}] ]
4. Match (objet filtrant 1 OU objet filtrant 2) ET objet filtrant 3 ; [ [{filter object 1},{filter object 2}], [{filter object 3}] ].

En développant davantage les objets filtrants de l'exemple 4, nous obtenons la requête filtrante suivante :

[
   [
      {
         "field":"vertical",
         "type":"==",
         "value":"REAL_ESTATE"
      },
      {
         "field":"vertical",
         "type":"==",
         "value":"NGO"
      }
   ],
   [{
      "field":"reseller_id",
      "type":"==",
      "value":"12345"
   }]
]