Obter relatório resumido no Toggl Track, por uma API

Retorna o tempo registrado de um workspace em um período, em segundos, agrupado por projeto, cliente ou usuário e subagrupado, para todos que o usuário pode ver. Exige start_date. Os grupos e subgrupos trazem ids, cujos nomes vêm de Listar projetos e Listar clientes.

Identificador
toggl_get_summary_report

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
workspace_idintegerSimId 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_datestringSimFirst day of the period, as yyyy-MM-dd.
end_datestringNãoLast day of the period, as yyyy-MM-dd, included.
groupingstringNãoWhat the groups are: projects (the default), clients or users.
sub_groupingstringNãoWhat each group is split by: time_entries (the default), tasks, projects, clients or users, never the same as grouping.
project_idsarrayNãoOnly these projects, by id from List projects.
client_idsarrayNãoOnly these clients, by id from List clients.
descriptionstringNãoOnly entries whose description matches this text.
billablebooleanNãoTrue for billable time only, false for non-billable only. Paid plans only.

Conexões possíveis

O seu cliente conecta a conta do Toggl Track uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Usuário e senha

O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/toggl_get_summary_report. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Toggl Track

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.