Listar tipos de objetos de dados

Use este endpoint para listar os tipos de objetos de dados em um espaço de trabalho.

Importante

Data Objects está atualmente em acesso antecipado. Seu espaço de trabalho precisa estar ativado antes que as permissões de chave de API de Data Objects apareçam em Configurações > Chaves de API.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão data_objects.read.

Limite de frequência

Este endpoint está no bucket de leitura de Data Objects com um limite padrão de 50 solicitações por minuto.

Parâmetros de consulta

A tabela a seguir lista e descreve os parâmetros de consulta para o endpoint /data_objects/types.

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil de parâmetros de consulta e um exemplo de solicitação cURL.

Exemplo de carga útil da solicitação

Use este objeto JSON como referência para os parâmetros de consulta nesta solicitação.

1
2
3
4
5

{
  "search_term": "acc",
  "limit": 2,
  "offset": 0
}

Exemplo de solicitação cURL

Este exemplo lista os tipos de objetos de dados que correspondem ao termo de busca acc, retornando dois resultados por página.

1
2

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

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "items": [
    {
      "type_name": "account",
      "metadata": { "display_name_source": "name" }
    },
    {
      "type_name": "contact",
      "metadata": {}
    }
  ],
  "total_count": 2,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

metadata.display_name_source está presente quando um campo de nome de exibição está configurado para o tipo.

Parâmetros da resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Erros

A tabela a seguir lista os erros comuns para este endpoint e como resolvê-los.