Get hourly activity
getHourlyActivityPermission read
Analítica hour by hour for one plant day, from the marcas log: units, meta, efficiency, billing and pace per hour, for the plant, one módulo or one operario.
/v1/external/organizations/{organizationId}/analytics/hourlyWhat it is: «Analítica» hour by hour for one plant day, the hourly view of the dashboard’s «Reportes», tab «Analítica». hours holds one entry per clock hour with activity and totals the day. Without a filter it is the whole plant; moduleId narrows it to one «módulo»; operatorId to one «operario» (their own «marcas» and their share of each hour’s «meta», so its totals equal that person’s row of getOperatorsActivity). moduleId and operatorId are echoed in the answer, null when not sent.
How it is computed: units, goal, efficiency, billableUnits and billedAmount come from the hourly buckets, so they agree with the reports (goal is the sum of each «puesto»’s «meta» for the hour). events, online, offline, legacy, the two secondsPerUnit percentiles and idleGapsOverN come from the «marcas» log. A gap is counted in the hour of its later «marca», so the hours add up to the totals.
Source: «Analítica» reads the «marcas» log (one row per unit an «operario» registered on the app, with its time and channel) beside the hourly buckets the reports are built from, so it can tell pace, connectivity and gaps that the reports cannot.
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.
Money is «Facturación»: the units of the «puestos de salida» × the price per unit each was billed at, in the plant’s currency (currency, ISO 4217: EUR for a plant in España, COP for every other), in whole currency units with up to 2 decimals, never cents. Whether a money figure reads null or 0 where nothing was priced is stated on each field. billableUnits and billedAmount are null, not 0, when no «puesto de salida» is in what was asked.
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 analytics («Analítica»), 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: "analytics". getPlan features lists what the organization’s plan has.
See also: getOperatorsActivity for the same day by «operario»; getConsistency to check the log against the buckets.
Authorization
apiToken An API token created in Configuración › Tokens de API, or a connected app’s access token
In: header
Path Parameters
The organization, from getMe or listOrganizations.
Query Parameters
The plant day to read, YYYY-MM-DD on the plant’s own clock (the organization’s timezone, never UTC). Omitted: the plant’s today on that clock; the answer’s day says which day was read. Not a real calendar day: 400 INVALID_DAY.
^\d{4}-\d{2}-\d{2}$length <= 10Narrow the answer to one «módulo»: the id of one from listModules. Omitted: the whole plant. Of another organization or unknown: 404 MODULE_NOT_FOUND.
1 <= value <= 2147483647Narrow the answer to one «operario» (the id of one from listOperators): their own «marcas» and their share of each hour’s «meta». Omitted: every «operario». Of another organization or unknown: 404 OPERATOR_NOT_FOUND.
1 <= value <= 2147483647In minutes: a gap between two consecutive «marcas» longer than this counts as one «pausa sin registro» (idleGapsOverN, idleGaps). One of 5, 10 or 15; default 5. The answer echoes the value used.
Value in
- 5
- 10
- 15
Response Body
application/json
application/json
curl -X GET "https://api.fluenta.io/v1/external/organizations/0/analytics/hourly" \ -H "Authorization: Bearer fluenta_live_XXXX"{ "moduleId": 0, "operatorId": 0, "hours": [ { "hour": 0, "units": 0, "billableUnits": 0, "billedAmount": 0, "goal": 0, "efficiency": 0, "events": 0, "online": 0, "offline": 0, "legacy": 0, "secondsPerUnitP50": 0, "secondsPerUnitP90": 0, "idleGapsOverN": 0 } ], "totals": { "units": 0, "billableUnits": 0, "billedAmount": 0, "goal": 0, "efficiency": 0, "events": 0, "online": 0, "offline": 0, "legacy": 0, "secondsPerUnitP50": 0, "secondsPerUnitP90": 0, "idleGapsOverN": 0, "offlineShare": 0, "eventsWithoutBucket": 0, "idleMinutesApplied": 0 }, "day": "string", "currency": "string"}