Configure an Integration API

Use the Integration screen to select the data source and define the columns, values, and filters for the external API link. Any system with a valid token can POST {} to that link and receive the latest data.

Configure Data for External Access

Follow these best practices when you configure data for external access:

  • Include a Date or Shift field so downstream systems can filter by time.
  • Use Quick Links periods (for example, Last 7 Days) for rolling integrations.
  • Minimise the number of columns—only include what consuming systems need.
  • Lock production configurations to prevent accidental edits.
  • Version carefully—clone with Save As before you change schemas.
  • Store the External Link in a secure credential manager for security.

Activity Steps

  1. Open the Integration Screen.
  2. Click the Configure Data icon on the right-hand toolbar.

    The Configure Data panel displays.

  3. Select the data Source from:
    • Metrics – Aggregated measures for elements on the mine value chain (for example, Mine Production, Plant Feed, Crusher Received).
    • Movements – Material movement transactions (for example, Haulage, Control Point transactions).
    • Stockpiles – Stockpile balances and adjustments (Opening and Closing balances, Additions and Removals).
  4. Select the fields to group or filter by from the Columns (Dimensions) drop-down list. For example, Site, Area, Material, Equipment, Control Point.

    Note: Include a Date or Shift field so downstream systems can filter by date.

  5. Select the numeric or attribute outputs to include from the Values (Measures) drop-down list. For example, Wet Tonnes, Dry Tonnes, Volume, grades, metals, and attributes.
  6. Click Apply to update the screen's table and keep the Configure Data panel open.
  7. Click Apply & Close to update the screen's table and close the Configure Data panel.
  8. Apply filters if required.
    1. To filter by Period:
      • Check the Period box and select a range, time period or a Quick Link (for example, Last 7 Days). Quick Links are relative to the date the API is queried.
      • Uncheck Period only if you want all available data.
    2. To further narrow the dataset, select Custom filter columns and values (for example, limit to specific metrics, material types, or areas).
    3. Click the refresh icon to apply the selected filters.
  9. Save and manage the configuration:
    1. Click the ellipsis (…) next to the configuration name and select Save As.
    2. Enter or update the configuration Name.
    3. Set Visibility to Private or Global.
    4. Set the configuration to Locked if required.

      Note: Locked configurations can only be edited after being unlocked via the Analysis Configurations Screen.

    5. Click Save.

    The configuration saves.

  10. To copy the API URL, click the ellipsis (…) next to the configuration name and select Copy External Link.

    The URL copies to the clipboard.

    Important: Treat the link like a credential and share only with trusted systems. Calling the external link requires an OAuth2 client-credentials bearer token and a POST request with an empty JSON body {}. The response is raw JSON matching your selected Columns and Values.

Authenticate and Call the API

Every client (for example, Postman, Python, Excel/Power Query, Power BI, curl, and ETL tools) exposes HTTP method, headers, and body in different places; however, the steps are the same.

Activity Steps

  1. To request a token, POST /identity/connect/token with:
    • Basic authentication (client_id:client_secret).
    • Form body: grant_type=client_credentials
  2. To call the dataset, POST the External Link URL you copied with:
    • Header: Authorization: Bearer <access_token>
    • Header: Content-Type: application/json
    • Body: {} (empty JSON object).

Troubleshooting the API

Issue: No Data Returned

  • Verify the Period filter is correctly checked or unchecked.
  • Check the Quick Link period and Custom filters.
  • Ensure you used POST with body {} and a valid Bearer token.

Issue: 401/403 (Unauthorized/Forbidden)

  • Token may be missing, expired or invalid. Re-request and include the Authorization header.
  • Check the Basic authentication credentials for the token request.