Segmentação / Audiências

Recupera os registros pertencentes a uma audiência previamente gerada, identificada por um list_id.
Os resultados são retornados de forma paginada.
Para receber o list_id, favor solicitar via abertura de chamado.


Endpoint

GET https://segments-xp.wake.tech/v1/lists/{list_id}

🔐 Autenticação

Requer um token Bearer válido. (Ver seção Optin / Gerar Token)


🔸 Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
list_idstringpathID único da audiência cadastrada para exportação.
limitintegerqueryQuantidade de itens por página. Padrão: 10. Mínimo: 10, Máximo: 100.
pageintegerqueryNúmero da página a ser retornada. Padrão: 1. Mínimo: 1.

📥 Exemplo de Requisição

GET /v1/lists/abc123?limit=20&page=1 HTTP/1.1
Host: https://segments-xp.wake.tech
Authorization: Bearer seu_token_aqui

✅ Exemplo de Resposta 200

{
  "total": 2,
  "page": 1,
  "total_pages": 1,
  "success": true,
  "limit": 10,
  "last_updated": "2025-04-30T14:23:00Z",
  "result": [
   {
      "id": "1a2b3c",
      "name": "Maria Silva",
      "email": "[email protected]",
      "created_at": "2024-12-10T08:00:00Z"
    },
    {
      "id": "4d5e6f",
      "name": "João Oliveira",
      "email": "[email protected]",
      "created_at": "2024-12-12T10:15:30Z"
    },
  ]
}
CampoTipoDescrição
totalintegerTotal de registros encontrados.
pageintegerPágina atual.
total_pagesintegerNúmero total de páginas.
successbooleanIndica se a operação foi bem-sucedida.
limitintegerQuantidade de registros por página.
last_updatedstringData/hora da última atualização da lista.
resultarrayLista dos registros exportáveis.


🧩 Códigos de Resposta

CódigoDescrição
200Requisição bem-sucedida
401Não autorizado
404Audiência não encontrada
422Erro de validação

⚠️ Erro 422 - Validation Error

{
  "detail": [
    {
      "loc": ["string", 0],
      "msg": "string",
      "type": "string"
    }
  ]
}
CampoTipoDescrição
locarrayLocal do parâmetro inválido.
msgstringMensagem descritiva do erro.
typestringTipo do erro de validação.