FluentaAPI

Get module efficiency

getModuleEfficiencyPermiso read

One módulo’s «Eficiencia» per day over a range of up to 92 plant days: units made against the meta, every puesto counted. The chart of «Reportes por módulo».

GET/v1/external/organizations/{organizationId}/modules/{moduleId}/analytics/efficiency

What it is: one «módulo»’s «Eficiencia» day by day, the chart of «Reportes por módulo». Each entry of days is one plant day: units made by every «puesto» of the «módulo», goal the sum of each «puesto»’s «meta» for each hour it worked, and efficiency their ratio.

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.

Range: from and to are plant days, both included, at most 92 days apart counting both (RANGE_TOO_LARGE past it); for a longer span, ask consecutive ranges. days is oldest first, and a day with no work in the range is no row, not a row of zeros.

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.

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

Heavy read: besides the credential’s ordinary budget it spends the heavy one, 20 requests per 60 seconds per credential and organization; past it the answer is 429 RATE_LIMITED with Retry-After.

See also: getModuleDayHistory for one of those days hour by hour; getEfficiency with groupBy=module for every «módulo» at once.

Autorización

apiToken
AutorizaciónBearer <token>

An API token created in Configuración › Tokens de API, or a connected app’s access token

En: header

Parámetros de ruta

moduleId*integer

The «módulo» (a production line): the id of one from listModules. Unknown or of another organization: 404 MODULE_NOT_FOUND.

organizationId*integer

The organization, from getMe or listOrganizations.

Parámetros de consulta

from*string

First plant day of the range, YYYY-MM-DD on the plant’s own clock, included. At most 92 days from from to to, counting both: past it, 400 RANGE_TOO_LARGE.

Patrón^\d{4}-\d{2}-\d{2}$
Longitudlength <= 10
to*string

Last plant day of the range, YYYY-MM-DD on the plant’s own clock, included. Before from: 400 RANGE_INVALID.

Patrón^\d{4}-\d{2}-\d{2}$
Longitudlength <= 10

Respuestas

application/json

application/json

curl -X GET "https://api.fluenta.io/v1/external/organizations/0/modules/0/analytics/efficiency?from=2026-10-01&to=2026-10-31" \  -H "Authorization: Bearer fluenta_live_XXXX"
{  "module": {    "id": 0,    "name": "string"  },  "from": "string",  "to": "string",  "days": [    {      "day": "string",      "units": 0,      "goal": 0,      "efficiency": 0    }  ]}