Atividades
Listar Atividades
Obter uma lista paginada de atividades com filtros.
GET /api/activities
Retorna uma lista paginada de atividades com filtros opcionais.
Auth: Obrigatório — permissão activity:view
Parâmetros de Consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | number | 1 | Número da página |
per_page | number | 25 | Itens por página (máx. 100) |
search | string | - | Buscar atividades |
status | string | - | Filtrar por status da atividade (veja Activity States). Valores filtráveis: READY, RETRYING, DISPATCHED, COMPLETED, CANCELED, FAILED |
type | string | - | Filtrar por tipo (TASK) |
channel | string | - | Filtrar por canal |
commerce_id | UUID | - | Filtrar por comércio |
scheduled_from | ISO 8601 | - | Filtrar a partir da data agendada |
scheduled_to | ISO 8601 | - | Filtrar até a data agendada |
Exemplo
curl "https://api.reten.ai/api/activities?status=READY&type=TASK&page=1&per_page=10" \
-H "Authorization: Bearer <token>" \
-H "x-tenant-id: <tenant-id>" \
-H "x-project-id: <project-id>"const params = new URLSearchParams({ status: "READY", type: "TASK", page: "1", per_page: "10" });
const response = await fetch(`https://api.reten.ai/api/activities?${params}`, {
headers: {
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
"x-project-id": "<project-id>",
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.reten.ai/api/activities",
headers={
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
"x-project-id": "<project-id>",
},
params={"status": "READY", "type": "TASK", "page": 1, "per_page": 10},
)
data = response.json()Resposta 200 OK
{
"data": [
{
"id": "ee0e8400-e29b-41d4-a716-446655440000",
"projectId": "3f6c2b1a-8d4e-4f7a-9b2c-5e1d0a7f6c34",
"type": "TASK",
"reason": {
"code": "retention",
"label": "Retencion"
},
"channel": "SALESMAN",
"status": "READY",
"userStatus": {
"code": "at_risk",
"label": "En Riesgo"
},
"scheduledAt": "2025-01-16T09:00:00.000Z",
"commerceAssignment": {
"commerceId": "880e8400-e29b-41d4-a716-446655440000",
"commerce": {
"name": "Main Street Store"
}
}
}
],
"pagination": {
"page": 1,
"per_page": 10,
"total": 1,
"total_pages": 1,
"has_next": false,
"has_previous": false
}
}