Esta API permite obtener los envíos realizados en los formularios de tu portal DataCrush, incluyendo información del envío, parámetros UTM y los valores capturados en cada campo del formulario.
¿Qué información devuelve?
Por cada envío de formulario, la API puede devolver:
- Fecha y hora de envío.
- URL desde donde se completó el formulario.
- Origen del envío.
- Parámetros UTM asociados.
- Valores ingresados por el usuario en los campos del formulario.
Los resultados se devuelven paginados y cada registro representa un envío individual.
Requisitos previos
Antes de utilizar este endpoint necesitas contar con:
Portal ID
Identificador numérico de tu portal en DataCrush.
API Key
Clave de acceso obtenida desde la configuración de tu portal o usuario con permisos para utilizar la API.
Formulario existente
Debe existir al menos un formulario asociado al portal que coincida con los filtros enviados en la solicitud. En caso contrario, la API devolverá un error de acceso.
Opcionalmente puedes utilizar:
- ID de formulario (
id): identifica un formulario específico. - ID de página (
page_id): permite filtrar los envíos asociados a una landing creada con Web Builder.
Endpoint
GET https://api.datacrush.la/form/submission
La respuesta se devuelve en formato JSON.
Parámetros disponibles
portal_id: Identificador del portal. Obligatorio
api_key: API Key del portal o usuario. Obligatorio:
id: ID del formulario que deseas consultar.
page_id: ID de la landing o página asociada al formulario.
date_range: Período de tiempo predefinido para filtrar los envíos. Si no se especifica ningún criterio de fecha, se utilizará automáticamente el período correspondiente al mes actual (this_month).
date_from: Fecha inicial para filtros personalizados.
date_to: Fecha final para filtros personalizados.
page: Número de página para la paginación. Valor por defecto: 1. Cada página puede devolver hasta 1.000 registros.
Rangos de fecha soportados
La API admite distintos rangos predefinidos:
todayyesterdaypast_yesterdaythis_weeklast_weekthis_monthlast_monthactual_monththis_yearlast_yearthis_quarterlast_quartersemesterlast_7_dayslast_14_dayslast_30_dayslast_90_dayslast_365_dayscustomrangeall
Para utilizar un rango personalizado debes enviar:
date_range=custom date_from=2026-01-01 date_to=2026-01-31
Las fechas se procesan utilizando la zona horaria configurada en el portal.
Ejemplo de solicitud
GET https://api.datacrush.la/form/submission?portal_id=12345&api_key=TU_API_KEY&id=678&date_range=today&page=1
Ejemplo de respuesta exitosa
{
"result": "success",
"rows": [
{
"submit_source": "web",
"submit_url": "https://ejemplo.com/landing",
"submit_date": "2026-01-15 14:30:00",
"submit_utm_source": "google",
"submit_utm_medium": "cpc",
"submit_utm_campaign": "enero",
"submit_utm_term": "",
"submit_utm_content": "",
"email": "contacto@ejemplo.com",
"nombre": "María"
}
]
}
Campos incluidos en cada envío
Además de los datos propios del formulario, cada registro puede incluir información relacionada con el origen del envío.
Datos del envío
submit_sourcesubmit_urlsubmit_datesubmit_utm_sourcesubmit_utm_mediumsubmit_utm_campaignsubmit_utm_termsubmit_utm_content
Campos del formulario
La respuesta también incluirá los campos configurados para exportación dentro del formulario, por ejemplo:
{
"email": "usuario@ejemplo.com",
"nombre": "Juan Pérez",
"telefono": "+5491112345678"
}Los nombres de los campos dependen de la configuración específica de cada formulario.
Paginación
Los resultados se devuelven en bloques de hasta 1.000 registros.
Para avanzar a la siguiente página debes incrementar el parámetro page.
Ejemplo:
?page=2
Si una página devuelve menos de 1.000 registros, significa que has llegado al final de los resultados.
Respuestas de error
Error de acceso
{
"result": "fail",
"error": {
"code": 100,
"message": "Acceso denegado"
}
}Este error puede ocurrir cuando:
- El
portal_ides incorrecto. - La
api_keyes inválida. - El usuario o portal está inactivo.
- El formulario indicado no existe.
- El
page_idno corresponde a un formulario del portal.
Límite de solicitudes excedido
{
"result": "fail",
"error": {
"code": 101
}
}Este error indica que se superó el límite permitido de llamadas a la API.
Límites de uso
Esta API comparte los límites generales del portal:
- Máximo 30 solicitudes por minuto.
- El límite es compartido con el resto de los endpoints API.
- Se recomienda espaciar las consultas para evitar bloqueos temporales.
Resumen
- Obtén tu
portal_idyapi_key. - Identifica el formulario que deseas consultar.
- Define el rango de fechas.
- Realiza la llamada al endpoint.
- Procesa los registros recibidos en
rows. - Utiliza el parámetro
pagepara recuperar páginas adicionales cuando sea necesario.
Comentarios
0 comentarios
El artículo está cerrado para comentarios.