Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Listar objetos de datos

get

/data_objects/objects/{type_name}

Utiliza este endpoint para listar los objetos de un tipo de objeto de datos específico.

Importante

Los objetos de datos están disponibles de forma general, pero tu espacio de trabajo debe estar aprovisionado para Cuentas antes de que puedas usar este endpoint. Para solicitar el aprovisionamiento, ve a Configuración de datos > Cuentas y completa el cuestionario. Para más detalles, consulta Habilitar Cuentas.

Requisitos previos

Para utilizar este endpoint, necesitas una clave de API con el permiso data_objects.read.

Límite de velocidad

Este endpoint está en el contenedor de lectura de objetos de datos, con un límite predeterminado de 1000 solicitudes por minuto.

Parámetros de ruta

La siguiente tabla enumera y describe los parámetros de ruta del endpoint /data_objects/objects/{type_name}.

Parámetro	Obligatorio	Tipo de datos	Descripción
`type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos

Parámetros de consulta

La siguiente tabla enumera y describe los parámetros de consulta del endpoint /data_objects/objects/{type_name}.

Parámetro	Obligatorio	Tipo de datos	Descripción
`search_term`	Opcional	Cadena	Filtro de subcadena sobre el identificador del objeto
`limit`	Opcional	Entero	Tamaño de página. Predeterminado: `100`. Se restringe al rango de `1` a `250`
`offset`	Opcional	Entero	Desplazamiento. Predeterminado: `0`. Los valores negativos se ajustan a `0`

Ejemplo de solicitud

Esta sección incluye un ejemplo de carga útil de parámetros y un ejemplo de solicitud cURL.

Ejemplo de carga útil de solicitud

Utiliza este objeto JSON como referencia para los parámetros de la solicitud.

{
  "type_name": "account",
  "search_term": "acct",
  "limit": 100,
  "offset": 0
}

Ejemplo de solicitud cURL

Este ejemplo lista los registros de account que coinciden con el término de búsqueda acct y devuelve la primera página de resultados.

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account?search_term=acct&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Respuesta

Esta sección incluye un ejemplo de respuesta correcta y los campos de la respuesta.

Ejemplo de respuesta correcta

El código de estado 200 podría devolver el siguiente cuerpo de respuesta.

{
  "items": [
    {
      "type_name": "account",
      "object_id": "acct-123",
      "attributes": { "name": "Acme", "industry": "software" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

Parámetros de respuesta

La siguiente tabla enumera y describe los campos de una respuesta correcta.

Parámetro	Obligatorio	Tipo de datos	Descripción
`items`	Obligatorio	Matriz	Lista de registros de objetos de datos
`items[].type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos
`items[].object_id`	Obligatorio	Cadena	Identificador del objeto de datos
`items[].attributes`	Obligatorio	Objeto	Atributos del objeto indexados por nombre de campo
`total_count`	Obligatorio	Entero	Número total de registros coincidentes
`has_more`	Obligatorio	Booleano	Indica si hay otra página de resultados disponible
`next_offset`	Opcional	Entero	Desplazamiento de la siguiente página cuando `has_more` es `true`
`offset`	Obligatorio	Entero	Desplazamiento de la página actual
`limit`	Obligatorio	Entero	Tamaño de página utilizado en la solicitud

Errores

La siguiente tabla enumera los errores comunes de este endpoint y cómo resolverlos.

Estado	Causa	Orientación
`404`	Tipo no encontrado (`data-object-type-not-found`)	Comprueba que `type_name` exista en el espacio de trabajo y coincida exactamente con el nombre de máquina.
`401`	Clave de API REST ausente o no válida	Comprueba que el encabezado `Authorization` use `Bearer YOUR_REST_API_KEY` y que la clave esté activa.
`403`	La clave de API no tiene permiso o la lista de permitidos bloquea la solicitud	Comprueba que la clave tenga el permiso `data_objects.read` y que tu IP de origen esté en la lista de permitidos de la clave, si la has configurado.
`429`	Se superó el límite de velocidad	Vuelve a intentarlo después de `X-RateLimit-Reset` y reduce la frecuencia de las solicitudes.

New Stuff!