Filtrar los resultados de 10 DLC

Los 10 DLC GET Puntos de conexión de la API te 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 envían al punto final como parámetros de consulta. En tu consulta, utilizarás 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"}]]

Objeto de filtro

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 según cuyo valor deseas filtrar.

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

Valor: es el valor por el que quieres filtrar.

Condiciones de filtrado

  • regexp: Expresión regular - Devuelve los registros que coinciden con el valor del filtro según 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 - Busca registros que empiecen por el valor del filtro.
  • =$: Termina con - Coincide con los registros que terminan con el valor del filtro.
  • ~=: Contiene - Busca los registros que contengan el valor del filtro.
  • <: Menos de - coincide con registros inferiores al valor del filtro.
  • <=: Menor o igual que - muestra los registros cuyo valor sea menor o igual que el 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 coincidan con un objeto de filtro Y otra.

Consideremos el caso en el que queramos recuperar las marcas en las que el vertical es ESTADO_REAL O ONG Y donde el id del revendedor(reseller_id) es 12345.

Podemos expresar esto como una proposició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 deseas obtener resultados que coincidan con cualquiera de las siguientes opciones: objeto de filtro 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 objeto de filtro 1; [ [{filter object 1}] ].
  2. Partido objeto de filtro 1 Y filtro objeto 2; [ [{filter object 1}], [{filter object 2}] ]
  3. Partido objeto de filtro 1 O filtro objeto 2; [ [{filter object 1},{filter object 2}] ]
  4. Partido (objeto de filtro 1 O filtro objeto 2) Y objeto de filtro 3 ; [ [{filter object 1},{filter object 2}], [{filter object 3}] ].

NB: Los objetos de filtro siempre deben ir entre corchetes, aunque se trate de un solo objeto. Un buen ejemplo es el objeto de filtro 3 en el ejemplo 4 anterior.

Además, al ampliar 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"
   }]
]