Obtener informe resumen en Toggl Track, con una API
Devuelve el tiempo registrado de un workspace en un periodo, en segundos, agrupado por proyecto, cliente o usuario y subagrupado, para todos los que el usuario puede ver. Requiere start_date. Los grupos y subgrupos traen ids, cuyos nombres vienen de Listar proyectos y Listar clientes.
- Identificador
- toggl_get_summary_report
La llamada
POST https://connect.reportei.com/api/tools/toggl_get_summary_report/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"workspace_id": 1,
"start_date": "<start_date>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| workspace_id | integer | Sí | Id of the workspace: the default_workspace_id from Get me, the workspace_id of a project from List projects, or the wid of a client from List clients. |
| start_date | string | Sí | First day of the period, as yyyy-MM-dd. |
| end_date | string | No | Last day of the period, as yyyy-MM-dd, included. |
| grouping | string | No | What the groups are: projects (the default), clients or users. |
| sub_grouping | string | No | What each group is split by: time_entries (the default), tasks, projects, clients or users, never the same as grouping. |
| project_ids | array | No | Only these projects, by id from List projects. |
| client_ids | array | No | Only these clients, by id from List clients. |
| description | string | No | Only entries whose description matches this text. |
| billable | boolean | No | True for billable time only, false for non-billable only. Paid plans only. |
Conexiones posibles
Tu cliente conecta su cuenta de Toggl Track una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Usuario y contraseña
Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/toggl_get_summary_report. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Toggl Track
- Listar proyectosGETLista los proyectos de todos los workspaces del usuario, con id, workspace_id, client_id y nombre del cliente, marca billable y estado. De aquí salen los ids de workspace. Esta ruta cuenta en las 30 solicitudes por hora que Toggl da a cada usuario para rutas de nivel de usuario, en cualquier plan.
- Listar clientesGETLista los clientes de todos los workspaces del usuario, con id, nombre, notas, marca archived y el id del workspace en wid. Esta ruta cuenta en las 30 solicitudes por hora que Toggl da a cada usuario para rutas de nivel de usuario, en cualquier plan.
- Crear clientePOSTCrea un cliente en un workspace. Requiere name.
- Crear proyectoPOSTCrea un proyecto en un workspace, opcionalmente para un cliente. Requiere name. Billable es una función de pago.
- Actualizar proyectoPUTActualiza los campos enviados de un proyecto y conserva los demás. Archivar un proyecto es active false.
- Listar registros de tiempoGETLista los registros de tiempo más recientes del usuario conectado, hasta 1000. Para una ventana, envía start_date y end_date juntos; para periodos completos u otras personas, usa Obtener informe resumen. Esta ruta cuenta en las 30 solicitudes por hora que Toggl da a cada usuario para rutas de nivel de usuario, en cualquier plan.
- Obtener registro de tiempo actualGETDevuelve el registro de tiempo en curso del usuario conectado, con su id, o null cuando no hay ningún temporizador en marcha. Esta ruta cuenta en las 30 solicitudes por hora que Toggl da a cada usuario para rutas de nivel de usuario, en cualquier plan.
- Crear registro de tiempoPOSTCrea un registro de tiempo para el usuario conectado. Requiere workspace, workspace_id, created_with y start. Para un temporizador en marcha, envía duration -1; para trabajo pasado, envía duration en segundos o stop.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
