Previsualizar el último archivo de una lista

GET/v1/lists/{id}/preview

Para desarrolladores

Descripción

Devuelve las primeras líneas del último archivo subido a la lista, separadas en columnas. Sirve para revisar a qué campo del catálogo corresponde cada columna.

Las filas se separan con el mismo separador con el que se importa el archivo, así que cada columna ocupa aquí la posición que tendrá en la importación.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope list:read. Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Request

Path params:

idintegerobligatorio

Identificador de la lista.

Response

200 OKDevuelve un objeto con los campos que siguen.

import_idintegersiempre presente

Importación cuyo archivo dio la vista previa: la última que se subió.

encodingstringsiempre presente

Codificación detectada en el archivo.

delimiterstringsiempre presente

Separador de columnas detectado.

rowsstring[][]siempre presente

Hasta 10 líneas del archivo, cada una separada en columnas. Las líneas vacías se omiten.

Errores

Código	Cuándo
404	La lista no existe (list_not_found), o todavía no se le ha subido ningún archivo (list_preview_not_found).

Notas

• La vista previa es la del último archivo subido, aunque su importación haya fallado o siga en curso.
• Si el archivo trae encabezados, son la primera fila de rows.

Request

curl -X GET "https://$API_HOST/v1/lists/4/preview" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"import_id": 17,
"encoding": "cp1252",
"delimiter": ";",
"rows": [
  [
    "email",
    "nombre",
    "comuna"
  ],
  [
    "[email protected]",
    "Ana Muñoz",
    "Ñuñoa"
  ]
]
}