Skip to content

How Data Extraction Works

Most integrations that read from Ditio — BI dashboards, data warehouses, payroll systems — follow the same five stages. This page is the map; each stage links to the page with the detail.

1 Create API client Ditio Web 2 Get token Identity server 3 Call endpoint Data Extraction API 4 Paginate Continuation token 5 Sync changes ModifiedSince repeat on a schedule
  1. Create an API client to get a client id and secret — see Creating API credentials.

  2. Get a token with the reportingapiv1 scope, and reuse it until it expires — see Token Expiry.

  3. Call the endpoint on the reporting base with the token in the Authorization: Bearer header. Pick the endpoint for the data you want from the Data Extraction reference.

  4. Paginate through the result. Each response carries a continuationToken; pass it back on the next call until it comes back empty. This works the same on every extraction endpoint except /v1/item-registrations/web-query — see Pagination.

  5. Sync changes on a schedule. Instead of re-pulling everything, pass ModifiedSince (your last successful sync time) to get only records created or edited since then. Most endpoints also return deleted records, flagged with isDeleted; /v1/images doesn’t.

Seed your store with one full sync, then run incremental syncs on a timer. The two modes and their parameters are compared in Full vs incremental sync.

You want…EndpointPage
Hours workedv1/time-registrationsTime Registrations
Leave / absencev1/absence-registrationsAbsence Registrations
Machine usagev1/machine-registrationsMachine Registrations
Mass-haul tripsv1/flow-trip-registrationsMass Transport Registrations
HSE incidents & checklistsv1/incident-registrations, v1/checklist-registrationsSafety Reporting
Payroll resultv1/payroll-linesPayroll Lines
Site photosv1/imagesImage Extraction

To resolve the IDs that come back (userId, projectId, resourceId), pull the matching metadata endpoint once and join on your side. userId joins User Metadata’s identityUserId, not its id — see Resolving cross-references.