Lista de contenidos
Obtiene el tamaño de una lista de contenidos de un proyecto.
Este endpoint
es útil para conocer el número total de elementos de contenido, ya sea en general o filtrados por un modelo específico.
Por ejemplo, si tienes un modelo llamado post
, puedes usar esta función para obtener el número total de elementos de contenido de ese modelo.
Endpoint
curl https://api.contentisland.net/api/1.0/contents/size \--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO'
Query Params
Este endpoint acepta los siguientes query params
:
interface ContentListSizeQueryParams { id?: Filter; contentType?: Filter; language?: Filter; `fields.${string}`?: Filter; // Permite filtrar por valores específicos de campos // Por ejemplo: 'fields.slug': 'my-post'}
nombre | descripción |
---|---|
id | El campo id del contenido a recuperar. Este filtro es útil cuando se quiere recuperar una lista de contenidos pero se conoce los ids de éstos.Por ejemplo: /contents?id[in]=1,2,3 |
contentType | El modelo del contenido que queremos recuperar. Por ejemplo: /contents?contentType=post |
language | El idioma del contenido que queremos recuperar. Cuando aplicamos este filtro, solamente devolverá los campos del modelo en el idioma seleccionado y descartará los demás. Por ejemplo: /contents?language=es |
fields.${string} | Permite filtrar por valores específicos de campos. Ejemplos: /contents?fields.slug=my-post /contents?fields.title[in]=hello%20world,hola%20mundo Recupera contenidos con campos que coincidan con los valores especificados. |
type Filter = | string | { in?: string[]; // A futuro se añadirán más filtros };
nombre | descripción |
---|---|
string | Filtra el contentido donde el parámetro es igual a este valor.Por ejemplo: /contents?contentType=post Recupera una lista de contenidos cuyo modelo es igual a post |
in | Filtra el contenido donde el parámetro contiene alguno de estos valores.Por ejemplo: /contents?language[in]=es,en Recupera una lista de contenidos filtrando los campos que coincidan con es y/o en |
Ejemplo:
// Recupera una lista de contenidos filtrando por el modelo y el idiomacurl https://api.contentisland.net/api/1.0/contents/size?contentType=post&language[in]=es,en \--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO'
Respuesta
La respuesta de este endpoint es un número que representa el tamaño de la lista de contenidos que coinciden con los parámetros de consulta proporcionados.
42 // Ejemplo de respuesta que indica el tamaño de la lista de contenidos
Códigos de estado
Código | Descripción |
---|---|
200 | La solicitud se ha procesado correctamente y se ha devuelto la información del proyecto. |
401 | No autorizado. El token de acceso no es válido o ha expirado. |
500 | Error interno del servidor. Ocurrió un error al procesar la solicitud. |