Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Listar objetos de dados

get

/data_objects/objects/{type_name}

Use este endpoint para listar objetos de um tipo de objeto de dados específico.

Importante

O recurso Objetos de dados está disponível para todos, mas seu espaço de trabalho precisa estar provisionado para Contas antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Contas e preencha o questionário. Para mais detalhes, consulte Ativar Contas.

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 Objetos de dados, com um limite padrão de 1000 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho do endpoint /data_objects/objects/{type_name}.

Parâmetro	Obrigatório	Tipo de dados	Descrição
`type_name`	Obrigatório	String	Nome de máquina do tipo de objeto de dados

Parâmetros de consulta

A tabela a seguir lista e descreve os parâmetros de consulta do endpoint /data_objects/objects/{type_name}.

Parâmetro	Obrigatório	Tipo de dados	Descrição
`search_term`	Opcional	String	Filtro de substring no identificador do objeto
`limit`	Opcional	Inteiro	Tamanho da página. Padrão `100`. Limitado ao intervalo de `1` a `250`
`offset`	Opcional	Inteiro	Deslocamento. Padrão `0`. Valores negativos são convertidos para `0`

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil de parâmetros 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 da solicitação.

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

Exemplo de solicitação cURL

Este exemplo lista os registros de account que correspondem ao termo de busca acct, retornando a primeira 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'

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.

{
  "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 da resposta

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

Parâmetro	Obrigatório	Tipo de dados	Descrição
`items`	Obrigatório	Array	Lista de registros de objetos de dados
`items[].type_name`	Obrigatório	String	Nome de máquina do tipo de objeto de dados
`items[].object_id`	Obrigatório	String	Identificador do objeto de dados
`items[].attributes`	Obrigatório	Objeto	Atributos do objeto indexados pelo nome do campo
`total_count`	Obrigatório	Inteiro	Número total de registros correspondentes
`has_more`	Obrigatório	Booleano	Indica se há outra página de resultados disponível
`next_offset`	Opcional	Inteiro	Deslocamento para a próxima página quando `has_more` é `true`
`offset`	Obrigatório	Inteiro	Deslocamento da página atual
`limit`	Obrigatório	Inteiro	Tamanho da página utilizado pela solicitação

Erros

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

Status	Causa	Orientação
`404`	Tipo não encontrado (`data-object-type-not-found`)	Confirme que `type_name` existe no espaço de trabalho e corresponde exatamente ao nome de máquina.
`401`	Chave da API REST ausente ou inválida	Verifique se o cabeçalho `Authorization` usa `Bearer YOUR_REST_API_KEY` e se a chave está ativa.
`403`	A chave de API não tem permissão ou a solicitação está bloqueada pela lista de permissões	Confirme que a chave possui a permissão `data_objects.read` e que o seu IP de origem está na lista de permissões da chave, se configurada.
`429`	Limite de frequência excedido	Tente novamente após `X-RateLimit-Reset` e reduza a frequência das solicitações.

New Stuff!