Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve los datos generales del dominio.
Parámetros
Nombre | Tipo | Descripción |
page | Integer | Número de página. Por defecto: 1. |
limit | Integer | Registros por página. Por defecto: 10. Máximo: 100. |
sort | String | Ordenar por: name, created_date. Por defecto: created_date. |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: desc. |
filters | String | Expresión para filtrar registros. Ver detalle de Generación de expresiones. |
Respuesta
Campo | Descripción |
id | ID de dominio |
name | Nombre del dominio |
created_date | Fecha de creación (UTC+00:00) |
deleted_date | Fecha de eliminación (UTC+00:00) |
counters.mail_processed | Emails procesados |
health | Reputación: unknown (no disponible), blocked (mala), warning (regular), good (excelente) |
status | Estado: verified, not_verified, paused, deleted |
Errores
Error | Descripción |
malformed_filter | Expresión de filtro incorrecta |
invalid_page | Número de página incorrecto — debe ser entero positivo |
invalid_limit | Cantidad de registros incorrecta — debe ser entero positivo |
Ejemplo de respuesta
{
"page": 1,
"limit": 10,
"payload": [
{
"id": "8952a87b807877b0d199e2a8",
"name": "tudominio.com",
"created_date": "2024-03-15T18:08:59+00:00",
"deleted_date": null,
"counters": {
"mail_processed": 132
},
"health": "good",
"status": "verified"
}
],
"total": 1
}