Exportaciones

Requisitos de ámbito

Utiliza la API de exportaciones para exportar registros y datos de propiedades desde tu cuenta de HubSpot, obtén una URL para descargar un archivo de exportación o ver el estado de una exportación. En HubSpot, también puedes exportar registros o ver un historial de exportaciones anteriores en tu cuenta.

Iniciar una exportación

Para iniciar una exportación, haz una solicitud POST a /crm/v3/exports/export/async. El cuerpo de la solicitud debe especificar información como el formato del archivo, el objeto y las propiedades que deseas exportar y el tipo de exportación que estás completando (por ejemplo, exportar una vista de objeto o una lista). También puedes filtrar los datos de propiedades que se exportarán en función de operadores específicos. Tanto para las exportaciones de vistas como de listas, puedes incluir los siguientes campos en tu solicitud:

Parámetro	Descripción
`exportType`	El tipo de exportación, ya sea `VIEW` (para exportar una vista de una página de índice de objetos) o `LIST` (para exportar una lista).
`format`	El formato del archivo. Las opciones incluyen `XLSX`, `CSV`, o `XLS`.
`exportName`	El nombre de la exportación.
`language`	El idioma del archivo de exportación. Las opciones incluyen `DE`, `EN`, `ES`, `FI`, `FR`, `IT`, `JA`, `NL`, `PL`, `PT`, o `SV`. Puedes encontrar más información sobre los idiomas compatibles aquí.
`objectType`	El nombre o el ID del objeto que estás exportando. Para objetos estándar, puedes utilizar los nombres de los objetos (por ejemplo `CONTACT`), pero para objetos personalizados, debes utilizar el valor `objectTypeId`. Puedes obtener este valor haciendo una solicitud `GET` a `/crm/v3/schemas`.
`associatedObjectType`	Los nombres o identificadores de los objetos asociados que hay que incluir en la exportación. Puedes exportar hasta cuatro objetos asociados por solicitud. Para los objetos asociados, la exportación contendrá los ID de registro asociados de ese objeto. Si solo exportas un objeto asociado o ajustas el campo `includePrimaryDisplayPropertyForAssociatedObjects` a `true`, también se exportarán los valores de la propiedad de visualización principal de los registros (por ejemplo, `name` para las empresas).
`objectProperties`	Una lista de las propiedades que quieres incluir en tu exportación. De forma predeterminada, los nombres y valores de las propiedades se muestran con las etiquetas legibles por humanos, pero puedes solicitar los nombres y valores internos utilizando el parámetro `exportInternalValuesOptions`.
`includePrimaryDisplayPropertyForAssociatedObjects`	Incluye este campo con el valor `true` para exportar los valores de la propiedad de visualización principal de todos los registros asociados (por ejemplo, `name` para empresas). Si solo vas a exportar un objeto asociado (indicado por el campo `associatedObjectType`), este se ajusta de forma predeterminada a `true`. Si exportas más de un objeto asociado, el valor se ajusta de forma predeterminada a `false`.
`includeLabeledAssociations`	Incluye este campo con el valor `true` para exportar etiquetas de asociación que describan la relación entre los registros asociados.
`exportInternalValuesOptions`	Incluye esta matriz para exportar los valores internos de los nombres y los valores de las propiedades. En la matriz, incluye `NAMES` para exportar los nombres internos de las propiedades (que se muestran como encabezados de las columnas) o `VALUES` para exportar los valores internos de las propiedades (por ejemplo, valores numéricos de las etapas de pipeline personalizadas o marcas de tiempo en lugar de fechas legibles por humanos).
`overrideAssociatedObjectsPerDefinitionPerRowLimit`	Incluye este campo con el valor `true` para anular el límite predeterminado de 1000 asociaciones por fila.

Exportar una vista

Si estás exportando una vista de la página de índice, el valor exportType debe ser VIEW, y puedes incluir el siguiente campo para filtrar y ordenar los registros que estás exportando:

Parámetro	Descripción
`publicCrmSearchRequest`	Indica qué datos deben ser exportados según ciertos valores de propiedad y consultas de búsqueda. Puedes incluir lo siguiente dentro del objeto: `filters`: las propiedades y los valores de la propiedad por los que se pueden filtrar los registros. `sorts`: el orden de los valores de una propiedad, ya sea ascendente `ASC`, o descendente, `DES`. `query`: una cadena para buscar los valores de los registros.

Por ejemplo, para exportar una vista de contactos y registros de empresas asociados, filtrados por la propiedad email y con los valores internos de los nombres y valores de las propiedades, tu solicitud sería similar a la siguiente:

JSON

///Example request body
{
  "exportType": "VIEW",
  "exportName": "All contacts",
  "format": "xlsx",
  "language": "DE",
  "objectType": "CONTACT",
  "exportInternalValuesOptions": ["NAMES", "VALUES"],
  "objectProperties": ["email", "firstname", "lastname"],
  "associatedObjectType": "COMPANY",
  "publicCrmSearchRequest": {
    "filters": [
      {
        "value": "hello@test.com",
        "propertyName": "email",
        "operator": "EQ"
      }
    ],
    "query": "hello",
    "sorts": [
      {
        "propertyName": "email",
        "order": "ASC"
      }
    ]
  }
}

Exportar una lista

Si estás exportando una lista, el valor exportType debe ser LIST, pero también debes especificar la lista que estás exportando con el siguiente campo:

Parámetro	Descripción
`listId`	El ID de lista ILS de la lista a exportar. Puedes encontrar el valor del ID de lista ILS a través de los detalles de listas en HubSpot. Navega a Contactos > Listas, coloca el cursor sobre la lista en la tabla, luego haz clic en Detalles. En el panel derecho, haz clic en Copiar ID de lista junto a los valores del ID de lista ILS. Las listas de contactos tienen dos valores de ID diferentes, pero debes usar el valor de ID de lista ILS en la solicitud.

Por ejemplo, para exportar una lista con los correos electrónicos de contactos, tu solicitud puede verse de la siguiente manera:

JSON

///Example request body
{
  "exportType": "LIST",
  "listId": 1234567,
  "exportName": "Marketing email contacts",
  "format": "xlsx",
  "language": "EN",
  "objectType": "CONTACT",
  "objectProperties": ["email"]
}

Buscar exportaciones

Cuando completes correctamente una exportación, el id de las exportaciones se devolverá en la respuesta. Para buscar una exportación de tu cuenta de HubSpot, haz una solicitud GET a /crm/v3/exports/export/async/tasks/{exportId}/status. Al buscar exportaciones, también se devolverá el status de la exportación. Los estados incluyen COMPLETE, PENDING, PROCESSING o CANCELED. Para las exportaciones con un estado COMPLETE, se devuelve una URL que puedes utilizar para descargar el archivo exportado. La URL de descarga expirará cinco minutos después de que se complete la solicitud. Una vez expirada, puedes realizar otra solicitud GET para generar una nueva URL única.

Nota:

Antes de que expire, se puede acceder a la URL de descarga de una exportación sin autorización adicional. Para proteger tus datos, procede con cautela al compartir una URL o al integrar con HubSpot a través de esta API.

Límites

Se aplican los siguientes límites:

Puedes realizar hasta treinta exportaciones en un plazo de 24 horas, y solo una exportación a la vez. Las exportaciones adicionales se pondrán en espera hasta que se complete la exportación anterior.
Si estás realizando una exportación grande, es posible que recibas varios archivos en un archivo zip. Se esperan varios archivos al exportar archivos CSV o XLSX con más de 1.000.000 de filas y archivos XLS con más de 65.535 filas. Los archivos CSV también se comprimen automáticamente si el archivo pesa más de 2 MB, aunque tenga menos de 1.000.000 de filas.
De forma predeterminada, el número de asociaciones por fila está limitado a 1.000 asociaciones. Si quieres anular este límite, incluye el campo overrideAssociatedObjectsPerDefinitionPerRowLimit con el valor true.

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Eventos

Archivos

Marketing

Programador

Webhooks

Iniciar una exportación

Exportar una vista

Exportar una lista

Buscar exportaciones

Nota:

Límites

​Iniciar una exportación

​Exportar una vista

​Exportar una lista

​Buscar exportaciones

​Nota:

​Límites

Iniciar una exportación

Exportar una vista

Exportar una lista

Buscar exportaciones

Nota:

Límites