Get efficiency by module

What it is: the table of the dashboard’s «Reportes», tab «Eficiencia», for one plant day: one row per «módulo» (a production line) with the units every one of its «puestos» made, the goal (the sum of each «puesto»’s «meta» for each hour it worked), the efficiency and the day’s «pausas» (pausedMinutes, pauses). modules is ordered by name; a «módulo» with only «pausas» that day is a row too, and one with nothing is no row.

The dashboard’s table groups by the «módulo»’s name, and so does this: two «módulos» that share a name are one row, whose moduleId is then null. getEfficiency with groupBy=module keeps them apart by id.

efficiency is «Eficiencia»: units made × 100 ÷ the «meta» of the same span, a percentage with 2 decimals (100 = exactly the goal, it can pass 100; never a 0–1 ratio), null where the goal is 0. Every «puesto» counts towards it, a «puesto de salida» or not.

Days and hours are the plant’s own: a plant day is a calendar day YYYY-MM-DD in the organization’s timezone (getOrganization timezone), never UTC, and an hour is the clock hour 0–23 that starts at it in that zone. day is optional: without it, the plant’s today on the organization’s own clock, as on every single-day route of the API externa; the answer’s day says which day was read.

Plan: needs the plan feature reports («Reportes»), the one its dashboard screen is gated by. Pro, a trial of Pro, an «exenta» organization and a Light of plan version 1 (getPlan planVersion) answer it; a Light of plan version 2 does not: 403 PLAN_LIMIT with feature: "reports". getPlan features lists what the organization’s plan has.

See also: getDayReport for the same day with each «módulo» hour by hour; getBillingByModule for the day’s «Facturación» by «módulo».

Parámetros de ruta

Parámetros de consulta

Respuestas

curl -X GET "https://api.fluenta.io/v1/external/organizations/0/analytics/efficiency/modules" \  -H "Authorization: Bearer fluenta_live_XXXX"

{  "day": "string",  "modules": [    {      "moduleId": 0,      "moduleName": "string",      "units": 0,      "goal": 0,      "efficiency": 0,      "pausedMinutes": 0,      "pauses": 0    }  ]}