Filtrar los resultados de 10 DLC

Los 10 DLC GET Puntos finales de la API le permiten acotar los resultados mediante filtros.

Por ejemplo, en lugar de obtener la lista de todas las marcas, podría estar interesado en las marcas dentro de la categoría ESTADO_REAL vertical. En este caso, puede aplicar un filtro para devolver ESTADO_REAL sólo marcas relacionadas.

Solicitar estructura

Los filtros se pasan al endpoint como parámetros de consulta. En su consulta, utilizará la palabra clave filter como clave seguida de la consulta en forma de objeto JSON.

He aquí un ejemplo:

https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/campaigns?filter=[[{"field":"vertical","type":"==","value":"REAL_ESTATE"}]]

Filtrar objeto

Un objeto de filtro es un objeto JSON que contiene una consulta de filtro. Un objeto de filtro contiene tres pares clave/valor:

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

Campo: es el nombre del campo por cuyo valor desea filtrar.

Tipo: es la condición de coincidencia que desea aplicar en el filtro de búsqueda. Visite el condiciones de filtrado para ver las condiciones disponibles.

Valor: es el valor por el que desea filtrar.

Condiciones del filtro

  • regexp: Regex - Devuelve los registros que coinciden con el valor del filtro basado en la expresión regular proporcionada.
  • ==: Igual a - Devuelve los registros que coinciden exactamente con el valor del filtro.
  • = : Pliegue igual - Coincide con los registros sin distinguir entre mayúsculas y minúsculas (Esto se aplica a los caracteres UTF-8).
  • ^=: Empieza por - Coincide con los registros que empiezan por el valor del filtro.
  • =$: Termina con - Coincide con los registros que terminan con el valor del filtro.
  • ~=: Contiene - Coincide con los registros que contienen el valor del filtro.
  • <: Menos de - coincide con registros inferiores al valor del filtro.
  • <=: Menor o igual que - coincide con los registros inferiores o iguales al valor del filtro.
  • >: Mayor que - coincide con los registros superiores al valor de filtro especificado.
  • >=: Mayor o igual que - coincide con los registros mayores o iguales al valor del filtro.

Puede obtener registros opuestos negando cualquiera de las condiciones anteriores anteponiendo a la condición el prefijo ! símbolo. Por ejemplo, !== es equivalente a No es igual.

Reglas de filtrado

Puede tener un máximo de tres filtrar objetos en una consulta. Esto significa que puede encontrar resultados que coincidan con un máximo de tres campos. Los objetos de filtro también se pueden emparejar de diferentes maneras.

Por ejemplo, puede obtener resultados que coincidan con un objeto de filtro O otro. Además, los resultados que coinciden con un objeto de filtro Y otra.

Tomemos el caso en el que queramos buscar marcas en las que la marca vertical es ESTADO_REAL O ONG Y donde el id del revendedor(reseller_id) es 12345.

Podemos expresarlo como una afirmación lógica: ( (vertical == REAL_ESTATE OR vertical == NGO) AND (reseller_id == 12345) )

Filtrar las consultas que implican O se representan mediante corchetes []. Por ejemplo, la siguiente expresión(vertical == REAL_ESTATE OR vertical == NGO) se convierte en [ [{filter object 1}, {filter object 2}] ].

El corchete interior indica que desea obtener resultados que coincidan con filtro objeto 1 O filtro objeto 2.

El corchete exterior marca el inicio de una consulta de filtro y es obligatorio y necesario para todas las consultas de filtro.

Ejemplos de reglas de filtrado

  1. Partido filtro objeto 1; [ [{filter object 1}] ].
  2. Partido filtro objeto 1 Y filtro objeto 2; [ [{filter object 1}], [{filter object 2}] ]
  3. Partido filtro objeto 1 O filtro objeto 2; [ [{filter object 1},{filter object 2}] ]
  4. Partido (filtro objeto 1 O filtro objeto 2) Y filtrar objeto 3 ; [ [{filter object 1},{filter object 2}], [{filter object 3}] ].

NB: Los objetos filtrantes siempre deben estar dentro de un corchete, incluso si se trata de un único objeto. Un buen ejemplo es el filtrar objeto 3 en el ejemplo 4 anterior.

Además, ampliando aún más los objetos de filtro del ejemplo 4. obtenemos la siguiente consulta de filtro:

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